Serialized Form

Package com.amazonaws

Class com.amazonaws.AbortedException extends AmazonClientException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.AmazonClientException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.AmazonServiceException extends AmazonClientException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

java.lang.String errorCode

The AWS error code represented by this exception (ex: InvalidParameterValue).

errorMessage

java.lang.String errorMessage

The error message as returned by the service.

errorType

AmazonServiceException.ErrorType errorType

Indicates (if known) whether this exception was the fault of the caller or the service.

See Also:

AmazonServiceException.ErrorType

requestId

java.lang.String requestId

The unique AWS identifier for the service request the caller made. The AWS request ID can uniquely identify the AWS request, and is used for reporting an error to AWS support team.

serviceName

java.lang.String serviceName

The name of the Amazon service that sent this error response.

statusCode

int statusCode

The HTTP status code that was returned with this error.

Package com.amazonaws.kinesisvideo.auth

Class com.amazonaws.kinesisvideo.auth.KinesisVideoCredentials extends java.lang.Object implements Serializable

Serialized Fields

accessKey

java.lang.String accessKey

expiration

java.util.Date expiration

secretKey

java.lang.String secretKey

sessionToken

java.lang.String sessionToken

Package com.amazonaws.kinesisvideo.client.mediasource

Class com.amazonaws.kinesisvideo.client.mediasource.UnknownMediaSourceException extends java.lang.RuntimeException implements Serializable

Class com.amazonaws.kinesisvideo.client.mediasource.UnsupportedConfigurationException extends java.lang.RuntimeException implements Serializable

Package com.amazonaws.kinesisvideo.common.exception

Class com.amazonaws.kinesisvideo.common.exception.KinesisVideoException extends java.lang.Exception implements Serializable

Package com.amazonaws.kinesisvideo.internal.service.exception

Class com.amazonaws.kinesisvideo.internal.service.exception.AccessDeniedException extends java.lang.RuntimeException implements Serializable

Class com.amazonaws.kinesisvideo.internal.service.exception.AmazonServiceException extends java.lang.RuntimeException implements Serializable

Class com.amazonaws.kinesisvideo.internal.service.exception.ResourceInUseException extends java.lang.RuntimeException implements Serializable

Class com.amazonaws.kinesisvideo.internal.service.exception.ResourceNotFoundException extends java.lang.RuntimeException implements Serializable

Package com.amazonaws.kinesisvideo.producer

Class com.amazonaws.kinesisvideo.producer.ProducerException extends KinesisVideoException implements Serializable

Serialized Fields

mStatusCode

int mStatusCode

Status code returned from native

Package com.amazonaws.mobile.auth.core.signin

Class com.amazonaws.mobile.auth.core.signin.AuthException extends java.lang.Exception implements Serializable

Serialized Fields

provider

IdentityProvider provider

Class com.amazonaws.mobile.auth.core.signin.CognitoAuthException extends ProviderAuthException implements Serializable

Class com.amazonaws.mobile.auth.core.signin.ProviderAuthException extends AuthException implements Serializable

Package com.amazonaws.mobile.auth.google

Class com.amazonaws.mobile.auth.google.GoogleSignInException extends java.lang.Exception implements Serializable

Serialized Fields

signInResult

com.google.android.gms.auth.api.signin.GoogleSignInResult signInResult

Reference to the SignIn result.

Package com.amazonaws.mobile.client.internal.oauth2

Class com.amazonaws.mobile.client.internal.oauth2.OAuth2Exception extends java.lang.RuntimeException implements Serializable

Serialized Fields

error

java.lang.String error

errorDescription

java.lang.String errorDescription

errorUri

java.lang.String errorUri

Package com.amazonaws.mobileconnectors.apigateway

Class com.amazonaws.mobileconnectors.apigateway.ApiClientException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.mobileconnectors.cognitoidentityprovider.exceptions

Class com.amazonaws.mobileconnectors.cognitoidentityprovider.exceptions.CognitoAuthenticationFailedException extends CognitoIdentityProviderException implements Serializable

serialVersionUID:

8165822545734303030L

Class com.amazonaws.mobileconnectors.cognitoidentityprovider.exceptions.CognitoCodeExpiredException extends CognitoIdentityProviderException implements Serializable

serialVersionUID:

2414443500383441666L

Class com.amazonaws.mobileconnectors.cognitoidentityprovider.exceptions.CognitoCodeMismatchException extends CognitoIdentityProviderException implements Serializable

serialVersionUID:

-267743909862371391L

Class com.amazonaws.mobileconnectors.cognitoidentityprovider.exceptions.CognitoIdentityProviderException extends AmazonClientException implements Serializable

serialVersionUID:

8038301061230088279L

Class com.amazonaws.mobileconnectors.cognitoidentityprovider.exceptions.CognitoInternalErrorException extends CognitoIdentityProviderException implements Serializable

serialVersionUID:

1591505124709311863L

Class com.amazonaws.mobileconnectors.cognitoidentityprovider.exceptions.CognitoLambdaException extends CognitoIdentityProviderException implements Serializable

serialVersionUID:

-2401240885762953890L

Class com.amazonaws.mobileconnectors.cognitoidentityprovider.exceptions.CognitoLambdaFailedException extends CognitoIdentityProviderException implements Serializable

serialVersionUID:

-2401240885762953890L

Class com.amazonaws.mobileconnectors.cognitoidentityprovider.exceptions.CognitoLambdaResponseInvalidException extends CognitoIdentityProviderException implements Serializable

serialVersionUID:

-7555105550171515590L

Class com.amazonaws.mobileconnectors.cognitoidentityprovider.exceptions.CognitoLambdaValidationException extends CognitoIdentityProviderException implements Serializable

serialVersionUID:

3986479981872163592L

Class com.amazonaws.mobileconnectors.cognitoidentityprovider.exceptions.CognitoLimitExceeded extends CognitoIdentityProviderException implements Serializable

serialVersionUID:

-6536154083710077612L

Class com.amazonaws.mobileconnectors.cognitoidentityprovider.exceptions.CognitoNotAuthorizedException extends CognitoIdentityProviderException implements Serializable

serialVersionUID:

-4496852554085318906L

Class com.amazonaws.mobileconnectors.cognitoidentityprovider.exceptions.CognitoParameterInvalidException extends CognitoIdentityProviderException implements Serializable

serialVersionUID:

-551253513463692597L

Class com.amazonaws.mobileconnectors.cognitoidentityprovider.exceptions.CognitoPasswordInvalidException extends CognitoIdentityProviderException implements Serializable

serialVersionUID:

8828738916097130105L

Class com.amazonaws.mobileconnectors.cognitoidentityprovider.exceptions.CognitoResourceNotFoundException extends CognitoIdentityProviderException implements Serializable

serialVersionUID:

-7875174258893803243L

Package com.amazonaws.mobileconnectors.dynamodbv2.dynamodbmapper

Class com.amazonaws.mobileconnectors.dynamodbv2.dynamodbmapper.DynamoDBMappingException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

-4883173289978517967L

Package com.amazonaws.mobileconnectors.geo.tracker

Class com.amazonaws.mobileconnectors.geo.tracker.TrackingError extends java.lang.Exception implements Serializable

Serialized Fields

recoverySuggestion

java.lang.String recoverySuggestion

type

TrackingError.Type type

Package com.amazonaws.mobileconnectors.iot

Class com.amazonaws.mobileconnectors.iot.AWSIotCertificateException extends AmazonClientException implements Serializable

Package com.amazonaws.mobileconnectors.kinesisvideo.camera

Class com.amazonaws.mobileconnectors.kinesisvideo.camera.KinesisVideoCameraException extends java.lang.RuntimeException implements Serializable

Package com.amazonaws.mobileconnectors.lambdainvoker

Class com.amazonaws.mobileconnectors.lambdainvoker.LambdaFunctionException extends AmazonClientException implements Serializable

serialVersionUID:

6674259958957646199L

Serialized Fields

details

java.lang.String details

Package com.amazonaws.mobileconnectors.lex.interactionkit.exceptions

Class com.amazonaws.mobileconnectors.lex.interactionkit.exceptions.AudioPlaybackException extends LexClientException implements Serializable

serialVersionUID:

-8398628163086836549L

Class com.amazonaws.mobileconnectors.lex.interactionkit.exceptions.DialogFailedException extends LexClientException implements Serializable

serialVersionUID:

-8628706898061817490L

Class com.amazonaws.mobileconnectors.lex.interactionkit.exceptions.InvalidParameterException extends LexClientException implements Serializable

serialVersionUID:

-6550393383171773655L

Class com.amazonaws.mobileconnectors.lex.interactionkit.exceptions.LexClientException extends AmazonClientException implements Serializable

serialVersionUID:

2731068214600265002L

Class com.amazonaws.mobileconnectors.lex.interactionkit.exceptions.MaxSpeechTimeOutException extends LexClientException implements Serializable

serialVersionUID:

2971175939403819423L

Class com.amazonaws.mobileconnectors.lex.interactionkit.exceptions.NoSpeechTimeOutException extends LexClientException implements Serializable

serialVersionUID:

-4850891951185614299L

Package com.amazonaws.mobileconnectors.lex.interactionkit.internal.audio

Class com.amazonaws.mobileconnectors.lex.interactionkit.internal.audio.AudioSourceException extends AmazonClientException implements Serializable

Package com.amazonaws.mobileconnectors.lex.interactionkit.internal.audio.encoder

Class com.amazonaws.mobileconnectors.lex.interactionkit.internal.audio.encoder.AudioEncoderException extends AmazonClientException implements Serializable

serialVersionUID:

-4016454290306351776L

Package com.amazonaws.mobileconnectors.lex.interactionkit.internal.vad

Class com.amazonaws.mobileconnectors.lex.interactionkit.internal.vad.VADException extends AmazonClientException implements Serializable

serialVersionUID:

-6299168403661684245L

Package com.amazonaws.mobileconnectors.pinpoint.internal.core

Class com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext extends java.lang.Object implements Serializable

Serialized Fields

analyticsClient

AnalyticsClient analyticsClient

analyticsServiceClient

AmazonPinpointAnalyticsClient analyticsServiceClient

applicationContext

android.content.Context applicationContext

configuration

AndroidPreferencesConfiguration configuration

notificationClient

NotificationClient notificationClient

pinpointConfiguration

PinpointConfiguration pinpointConfiguration

pinpointServiceClient

AmazonPinpointClient pinpointServiceClient

sdkInfo

SDKInfo sdkInfo

sessionClient

SessionClient sessionClient

system

AndroidSystem system

targetingClient

TargetingClient targetingClient

uniqueId

java.lang.String uniqueId

uniqueIdService

SharedPrefsUniqueIdService uniqueIdService

Package com.amazonaws.mobileconnectors.s3.transferutility

Class com.amazonaws.mobileconnectors.s3.transferutility.TransferUtilityException extends java.lang.Exception implements Serializable

Class com.amazonaws.mobileconnectors.s3.transferutility.TransferUtilityOptions extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

transferNetworkConnectionType

TransferNetworkConnectionType transferNetworkConnectionType

Type of connection to use for transfers.

transferServiceCheckTimeInterval

long transferServiceCheckTimeInterval

Deprecated.

This feature is deprecated since TransferService is changed to only support network connectivity changes.

TransferService checks for the transfers that are waiting or in progress and restarts the transfer for every time interval in milliseconds.

transferThreadPoolSize

int transferThreadPoolSize

Number of threads in the pool for the all the transfers.

Package com.amazonaws.services.cloudwatch.model

Class com.amazonaws.services.cloudwatch.model.AlarmHistoryItem extends java.lang.Object implements Serializable

Serialized Fields

alarmName

java.lang.String alarmName

The descriptive name for the alarm.

Constraints:
Length: 1 - 255

historyData

java.lang.String historyData

Machine-readable data about the alarm in JSON format.

Constraints:
Length: 1 - 4095

historyItemType

java.lang.String historyItemType

The type of alarm history item.

Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action

historySummary

java.lang.String historySummary

A human-readable summary of the alarm history.

Constraints:
Length: 1 - 255

timestamp

java.util.Date timestamp

The time stamp for the alarm history item.

Class com.amazonaws.services.cloudwatch.model.Datapoint extends java.lang.Object implements Serializable

Serialized Fields

average

java.lang.Double average

The average of metric values that correspond to the datapoint.

maximum

java.lang.Double maximum

The maximum of the metric value used for the datapoint.

minimum

java.lang.Double minimum

The minimum metric value used for the datapoint.

sampleCount

java.lang.Double sampleCount

The number of metric values that contributed to the aggregate value of this datapoint.

sum

java.lang.Double sum

The sum of metric values used for the datapoint.

timestamp

java.util.Date timestamp

The time stamp used for the datapoint.

unit

java.lang.String unit

The standard unit used for the datapoint.

Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

Class com.amazonaws.services.cloudwatch.model.DeleteAlarmsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

alarmNames

java.util.List<java.lang.String> alarmNames

A list of alarms to be deleted.

Class com.amazonaws.services.cloudwatch.model.DescribeAlarmHistoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

alarmName

java.lang.String alarmName

The name of the alarm.

Constraints:
Length: 1 - 255

endDate

java.util.Date endDate

The ending date to retrieve alarm history.

historyItemType

java.lang.String historyItemType

The type of alarm histories to retrieve.

Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action

maxRecords

java.lang.Integer maxRecords

The maximum number of alarm history records to retrieve.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The token returned by a previous call to indicate that there is more data available.

Constraints:
Length: 0 - 1024

startDate

java.util.Date startDate

The starting date to retrieve alarm history.

Class com.amazonaws.services.cloudwatch.model.DescribeAlarmHistoryResult extends java.lang.Object implements Serializable

Serialized Fields

alarmHistoryItems

java.util.List<AlarmHistoryItem> alarmHistoryItems

A list of alarm histories in JSON format.

nextToken

java.lang.String nextToken

A string that marks the start of the next batch of returned results.

Constraints:
Length: 0 - 1024

Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsForMetricRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dimensions

java.util.List<Dimension> dimensions

The list of dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the DescribeAlarmsForMetric to succeed.

metricName

java.lang.String metricName

The name of the metric.

Constraints:
Length: 1 - 255

namespace

java.lang.String namespace

The namespace of the metric.

Constraints:
Length: 1 - 255
Pattern: [^:].*

period

java.lang.Integer period

The period in seconds over which the statistic is applied.

Constraints:
Range: 60 -

statistic

java.lang.String statistic

The statistic for the metric.

Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum

unit

java.lang.String unit

The unit for the metric.

Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsForMetricResult extends java.lang.Object implements Serializable

Serialized Fields

metricAlarms

java.util.List<MetricAlarm> metricAlarms

A list of information for each alarm with the specified metric.

Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

actionPrefix

java.lang.String actionPrefix

The action name prefix.

Constraints:
Length: 1 - 1024

alarmNamePrefix

java.lang.String alarmNamePrefix

The alarm name prefix. AlarmNames cannot be specified if this parameter is specified.

Constraints:
Length: 1 - 255

alarmNames

java.util.List<java.lang.String> alarmNames

A list of alarm names to retrieve information for.

maxRecords

java.lang.Integer maxRecords

The maximum number of alarm descriptions to retrieve.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The token returned by a previous call to indicate that there is more data available.

Constraints:
Length: 0 - 1024

stateValue

java.lang.String stateValue

The state value to be used in matching alarms.

Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA

Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsResult extends java.lang.Object implements Serializable

Serialized Fields

metricAlarms

java.util.List<MetricAlarm> metricAlarms

A list of information for the specified alarms.

nextToken

java.lang.String nextToken

A string that marks the start of the next batch of returned results.

Constraints:
Length: 0 - 1024

Class com.amazonaws.services.cloudwatch.model.Dimension extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the dimension.

Constraints:
Length: 1 - 255

value

java.lang.String value

The value representing the dimension measurement

Constraints:
Length: 1 - 255

Class com.amazonaws.services.cloudwatch.model.DimensionFilter extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The dimension name to be matched.

Constraints:
Length: 1 - 255

value

java.lang.String value

The value of the dimension to be matched.

Specifying a Name without specifying a Value returns all values associated with that Name.

Constraints:
Length: 1 - 255

Class com.amazonaws.services.cloudwatch.model.DisableAlarmActionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

alarmNames

java.util.List<java.lang.String> alarmNames

The names of the alarms to disable actions for.

Class com.amazonaws.services.cloudwatch.model.EnableAlarmActionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

alarmNames

java.util.List<java.lang.String> alarmNames

The names of the alarms to enable actions for.

Class com.amazonaws.services.cloudwatch.model.GetMetricStatisticsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dimensions

java.util.List<Dimension> dimensions

A list of dimensions describing qualities of the metric.

endTime

java.util.Date endTime

The time stamp to use for determining the last datapoint to return. The value specified is exclusive; results will include datapoints up to the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).

metricName

java.lang.String metricName

The name of the metric, with or without spaces.

Constraints:
Length: 1 - 255

namespace

java.lang.String namespace

The namespace of the metric, with or without spaces.

Constraints:
Length: 1 - 255
Pattern: [^:].*

period

java.lang.Integer period

The granularity, in seconds, of the returned datapoints. Period must be at least 60 seconds and must be a multiple of 60. The default value is 60.

Constraints:
Range: 60 -

startTime

java.util.Date startTime

The time stamp to use for determining the first datapoint to return. The value specified is inclusive; results include datapoints with the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).

The specified start time is rounded down to the nearest value. Datapoints are returned for start times up to two weeks in the past. Specified start times that are more than two weeks in the past will not return datapoints for metrics that are older than two weeks.

Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using GetMetricStatistics.

statistics

java.util.List<java.lang.String> statistics

The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.

unit

java.lang.String unit

The unit for the metric.

Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

Class com.amazonaws.services.cloudwatch.model.GetMetricStatisticsResult extends java.lang.Object implements Serializable

Serialized Fields

datapoints

java.util.List<Datapoint> datapoints

The datapoints for the specified metric.

label

java.lang.String label

A label describing the specified metric.

Class com.amazonaws.services.cloudwatch.model.InternalServiceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudwatch.model.InvalidFormatException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudwatch.model.InvalidNextTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudwatch.model.InvalidParameterCombinationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudwatch.model.InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudwatch.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudwatch.model.ListMetricsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dimensions

java.util.List<DimensionFilter> dimensions

A list of dimensions to filter against.

metricName

java.lang.String metricName

The name of the metric to filter against.

Constraints:
Length: 1 - 255

namespace

java.lang.String namespace

The namespace to filter against.

Constraints:
Length: 1 - 255
Pattern: [^:].*

nextToken

java.lang.String nextToken

The token returned by a previous call to indicate that there is more data available.

Constraints:
Length: 0 - 1024

Class com.amazonaws.services.cloudwatch.model.ListMetricsResult extends java.lang.Object implements Serializable

Serialized Fields

metrics

java.util.List<Metric> metrics

A list of metrics used to generate statistics for an AWS account.

nextToken

java.lang.String nextToken

A string that marks the start of the next batch of returned results.

Constraints:
Length: 0 - 1024

Class com.amazonaws.services.cloudwatch.model.Metric extends java.lang.Object implements Serializable

Serialized Fields

dimensions

java.util.List<Dimension> dimensions

A list of dimensions associated with the metric.

metricName

java.lang.String metricName

The name of the metric.

Constraints:
Length: 1 - 255

namespace

java.lang.String namespace

The namespace of the metric.

Constraints:
Length: 1 - 255
Pattern: [^:].*

Class com.amazonaws.services.cloudwatch.model.MetricAlarm extends java.lang.Object implements Serializable

Serialized Fields

actionsEnabled

java.lang.Boolean actionsEnabled

Indicates whether actions should be executed during any changes to the alarm's state.

alarmActions

java.util.List<java.lang.String> alarmActions

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

alarmArn

java.lang.String alarmArn

The Amazon Resource Name (ARN) of the alarm.

Constraints:
Length: 1 - 1600

alarmConfigurationUpdatedTimestamp

java.util.Date alarmConfigurationUpdatedTimestamp

The time stamp of the last update to the alarm configuration.

alarmDescription

java.lang.String alarmDescription

The description for the alarm.

Constraints:
Length: 0 - 1024

alarmName

java.lang.String alarmName

The name of the alarm.

Constraints:
Length: 1 - 255

comparisonOperator

java.lang.String comparisonOperator

The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.

Constraints:
Allowed Values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold

dimensions

java.util.List<Dimension> dimensions

The list of dimensions associated with the alarm's associated metric.

evaluationPeriods

java.lang.Integer evaluationPeriods

The number of periods over which data is compared to the specified threshold.

Constraints:
Range: 1 -

insufficientDataActions

java.util.List<java.lang.String> insufficientDataActions

The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

The current WSDL lists this attribute as UnknownActions.

metricName

java.lang.String metricName

The name of the alarm's metric.

Constraints:
Length: 1 - 255

namespace

java.lang.String namespace

The namespace of alarm's associated metric.

Constraints:
Length: 1 - 255
Pattern: [^:].*

oKActions

java.util.List<java.lang.String> oKActions

The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

period

java.lang.Integer period

The period in seconds over which the statistic is applied.

Constraints:
Range: 60 -

stateReason

java.lang.String stateReason

A human-readable explanation for the alarm's state.

Constraints:
Length: 0 - 1023

stateReasonData

java.lang.String stateReasonData

An explanation for the alarm's state in machine-readable JSON format

Constraints:
Length: 0 - 4000

stateUpdatedTimestamp

java.util.Date stateUpdatedTimestamp

The time stamp of the last update to the alarm's state.

stateValue

java.lang.String stateValue

The state value for the alarm.

Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA

statistic

java.lang.String statistic

The statistic to apply to the alarm's associated metric.

Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum

threshold

java.lang.Double threshold

The value against which the specified statistic is compared.

unit

java.lang.String unit

The unit of the alarm's associated metric.

Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

Class com.amazonaws.services.cloudwatch.model.MetricDatum extends java.lang.Object implements Serializable

Serialized Fields

dimensions

java.util.List<Dimension> dimensions

A list of dimensions associated with the metric. Note, when using the Dimensions value in a query, you need to append .member.N to it (e.g., Dimensions.member.N).

metricName

java.lang.String metricName

The name of the metric.

Constraints:
Length: 1 - 255

statisticValues

StatisticSet statisticValues

A set of statistical values describing the metric.

timestamp

java.util.Date timestamp

The time stamp used for the metric in ISO 8601 Universal Coordinated Time (UTC) format. If not specified, the default value is set to the time the metric data was received.

unit

java.lang.String unit

The unit of the metric.

Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

value

java.lang.Double value

The value for the metric.

Although the Value parameter accepts numbers of type Double, Amazon CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (e.g., NaN, +Infinity, -Infinity) are not supported.

Class com.amazonaws.services.cloudwatch.model.MissingRequiredParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudwatch.model.PutMetricAlarmRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

actionsEnabled

java.lang.Boolean actionsEnabled

Indicates whether or not actions should be executed during any changes to the alarm's state.

alarmActions

java.util.List<java.lang.String> alarmActions

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer- account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east -1:{customer-account}:action/actions/AWS_EC2.InstanceId .Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions /AWS_EC2.InstanceId.Reboot/1.0

Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.

alarmDescription

java.lang.String alarmDescription

The description for the alarm.

Constraints:
Length: 0 - 1024

alarmName

java.lang.String alarmName

The descriptive name for the alarm. This name must be unique within the user's AWS account

Constraints:
Length: 1 - 255

comparisonOperator

java.lang.String comparisonOperator

The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.

Constraints:
Allowed Values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold

dimensions

java.util.List<Dimension> dimensions

The dimensions for the alarm's associated metric.

evaluationPeriods

java.lang.Integer evaluationPeriods

The number of periods over which data is compared to the specified threshold.

Constraints:
Range: 1 -

insufficientDataActions

java.util.List<java.lang.String> insufficientDataActions

The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer- account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east -1:{customer-account}:action/actions/AWS_EC2.InstanceId .Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions /AWS_EC2.InstanceId.Reboot/1.0

Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.

metricName

java.lang.String metricName

The name for the alarm's associated metric.

Constraints:
Length: 1 - 255

namespace

java.lang.String namespace

The namespace for the alarm's associated metric.

Constraints:
Length: 1 - 255
Pattern: [^:].*

oKActions

java.util.List<java.lang.String> oKActions

The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer- account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east -1:{customer-account}:action/actions/AWS_EC2.InstanceId .Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions /AWS_EC2.InstanceId.Reboot/1.0

Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.

period

java.lang.Integer period

The period in seconds over which the specified statistic is applied.

Constraints:
Range: 60 -

statistic

java.lang.String statistic

The statistic to apply to the alarm's associated metric.

Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum

threshold

java.lang.Double threshold

The value against which the specified statistic is compared.

unit

java.lang.String unit

The statistic's unit of measure. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.

Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to get stuck in the INSUFFICIENT DATA state.

Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

Class com.amazonaws.services.cloudwatch.model.PutMetricDataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

metricData

java.util.List<MetricDatum> metricData

A list of data describing the metric.

namespace

java.lang.String namespace

The namespace for the metric data.

You cannot specify a namespace that begins with "AWS/". Namespaces that begin with "AWS/" are reserved for other Amazon Web Services products that send metrics to Amazon CloudWatch.

Constraints:
Length: 1 - 255
Pattern: [^:].*

Class com.amazonaws.services.cloudwatch.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudwatch.model.SetAlarmStateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

alarmName

java.lang.String alarmName

The descriptive name for the alarm. This name must be unique within the user's AWS account. The maximum length is 255 characters.

Constraints:
Length: 1 - 255

stateReason

java.lang.String stateReason

The reason that this alarm is set to this specific state (in human-readable text format)

Constraints:
Length: 0 - 1023

stateReasonData

java.lang.String stateReasonData

The reason that this alarm is set to this specific state (in machine-readable JSON format)

Constraints:
Length: 0 - 4000

stateValue

java.lang.String stateValue

The value of the state.

Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA

Class com.amazonaws.services.cloudwatch.model.StatisticSet extends java.lang.Object implements Serializable

Serialized Fields

maximum

java.lang.Double maximum

The maximum value of the sample set.

minimum

java.lang.Double minimum

The minimum value of the sample set.

sampleCount

java.lang.Double sampleCount

The number of samples used for the statistic set.

sum

java.lang.Double sum

The sum of values for the sample set.

Package com.amazonaws.services.cognitoidentity.model

Class com.amazonaws.services.cognitoidentity.model.CognitoIdentityProvider extends java.lang.Object implements Serializable

Serialized Fields

clientId

java.lang.String clientId

The client ID for the Amazon Cognito user pool.

Constraints:
Length: 1 - 128
Pattern: [\w_]+

providerName

java.lang.String providerName

The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

Constraints:
Length: 1 - 128
Pattern: [\w._:/-]+

serverSideTokenCheck

java.lang.Boolean serverSideTokenCheck

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

Class com.amazonaws.services.cognitoidentity.model.ConcurrentModificationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentity.model.CreateIdentityPoolRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

allowClassicFlow

java.lang.Boolean allowClassicFlow

Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

allowUnauthenticatedIdentities

java.lang.Boolean allowUnauthenticatedIdentities

TRUE if the identity pool supports unauthenticated logins.

cognitoIdentityProviders

java.util.List<CognitoIdentityProvider> cognitoIdentityProviders

An array of Amazon Cognito user pools and their client IDs.

developerProviderName

java.lang.String developerProviderName

The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.

Constraints:
Length: 1 - 128
Pattern: [\w._-]+

identityPoolName

java.lang.String identityPoolName

A string that you provide.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

identityPoolTags

java.util.Map<java.lang.String,java.lang.String> identityPoolTags

Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

openIdConnectProviderARNs

java.util.List<java.lang.String> openIdConnectProviderARNs

The Amazon Resource Names (ARN) of the OpenID Connect providers.

samlProviderARNs

java.util.List<java.lang.String> samlProviderARNs

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

supportedLoginProviders

java.util.Map<java.lang.String,java.lang.String> supportedLoginProviders

Optional key:value pairs mapping provider names to provider app IDs.

Class com.amazonaws.services.cognitoidentity.model.CreateIdentityPoolResult extends java.lang.Object implements Serializable

Serialized Fields

allowClassicFlow

java.lang.Boolean allowClassicFlow

Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

allowUnauthenticatedIdentities

java.lang.Boolean allowUnauthenticatedIdentities

TRUE if the identity pool supports unauthenticated logins.

cognitoIdentityProviders

java.util.List<CognitoIdentityProvider> cognitoIdentityProviders

A list representing an Amazon Cognito user pool and its client ID.

developerProviderName

java.lang.String developerProviderName

The "domain" by which Cognito will refer to your users.

Constraints:
Length: 1 - 128
Pattern: [\w._-]+

identityPoolId

java.lang.String identityPoolId

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

identityPoolName

java.lang.String identityPoolName

A string that you provide.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

identityPoolTags

java.util.Map<java.lang.String,java.lang.String> identityPoolTags

The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

openIdConnectProviderARNs

java.util.List<java.lang.String> openIdConnectProviderARNs

The ARNs of the OpenID Connect providers.

samlProviderARNs

java.util.List<java.lang.String> samlProviderARNs

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

supportedLoginProviders

java.util.Map<java.lang.String,java.lang.String> supportedLoginProviders

Optional key:value pairs mapping provider names to provider app IDs.

Class com.amazonaws.services.cognitoidentity.model.Credentials extends java.lang.Object implements Serializable

Serialized Fields

accessKeyId

java.lang.String accessKeyId

The Access Key portion of the credentials.

expiration

java.util.Date expiration

The date at which these credentials will expire.

secretKey

java.lang.String secretKey

The Secret Access Key portion of the credentials

sessionToken

java.lang.String sessionToken

The Session Token portion of the credentials

Class com.amazonaws.services.cognitoidentity.model.DeleteIdentitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityIdsToDelete

java.util.List<java.lang.String> identityIdsToDelete

A list of 1-60 identities that you want to delete.

Class com.amazonaws.services.cognitoidentity.model.DeleteIdentitiesResult extends java.lang.Object implements Serializable

Serialized Fields

unprocessedIdentityIds

java.util.List<UnprocessedIdentityId> unprocessedIdentityIds

An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.

Class com.amazonaws.services.cognitoidentity.model.DeleteIdentityPoolRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityPoolId

java.lang.String identityPoolId

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Class com.amazonaws.services.cognitoidentity.model.DescribeIdentityPoolRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityPoolId

java.lang.String identityPoolId

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Class com.amazonaws.services.cognitoidentity.model.DescribeIdentityPoolResult extends java.lang.Object implements Serializable

Serialized Fields

allowClassicFlow

java.lang.Boolean allowClassicFlow

Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

allowUnauthenticatedIdentities

java.lang.Boolean allowUnauthenticatedIdentities

TRUE if the identity pool supports unauthenticated logins.

cognitoIdentityProviders

java.util.List<CognitoIdentityProvider> cognitoIdentityProviders

A list representing an Amazon Cognito user pool and its client ID.

developerProviderName

java.lang.String developerProviderName

The "domain" by which Cognito will refer to your users.

Constraints:
Length: 1 - 128
Pattern: [\w._-]+

identityPoolId

java.lang.String identityPoolId

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

identityPoolName

java.lang.String identityPoolName

A string that you provide.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

identityPoolTags

java.util.Map<java.lang.String,java.lang.String> identityPoolTags

The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

openIdConnectProviderARNs

java.util.List<java.lang.String> openIdConnectProviderARNs

The ARNs of the OpenID Connect providers.

samlProviderARNs

java.util.List<java.lang.String> samlProviderARNs

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

supportedLoginProviders

java.util.Map<java.lang.String,java.lang.String> supportedLoginProviders

Optional key:value pairs mapping provider names to provider app IDs.

Class com.amazonaws.services.cognitoidentity.model.DescribeIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityId

java.lang.String identityId

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Class com.amazonaws.services.cognitoidentity.model.DescribeIdentityResult extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

Date on which the identity was created.

identityId

java.lang.String identityId

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

lastModifiedDate

java.util.Date lastModifiedDate

Date on which the identity was last modified.

logins

java.util.List<java.lang.String> logins

The provider names.

Class com.amazonaws.services.cognitoidentity.model.DeveloperUserAlreadyRegisteredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentity.model.ExternalServiceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentity.model.GetCredentialsForIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customRoleArn

java.lang.String customRoleArn

The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

Constraints:
Length: 20 - 2048

identityId

java.lang.String identityId

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

logins

java.util.Map<java.lang.String,java.lang.String> logins

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax "provider_name": "provider_user_identifier".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

Class com.amazonaws.services.cognitoidentity.model.GetCredentialsForIdentityResult extends java.lang.Object implements Serializable

Serialized Fields

credentials

Credentials credentials

Credentials for the provided identity ID.

identityId

java.lang.String identityId

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Class com.amazonaws.services.cognitoidentity.model.GetIdentityPoolRolesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityPoolId

java.lang.String identityPoolId

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Class com.amazonaws.services.cognitoidentity.model.GetIdentityPoolRolesResult extends java.lang.Object implements Serializable

Serialized Fields

identityPoolId

java.lang.String identityPoolId

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

roleMappings

java.util.Map<java.lang.String,RoleMapping> roleMappings

How users for a specific identity provider are to mapped to roles. This is a String-to-RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".

roles

java.util.Map<java.lang.String,java.lang.String> roles

The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.

Class com.amazonaws.services.cognitoidentity.model.GetIdRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountId

java.lang.String accountId

A standard AWS account ID (9+ digits).

Constraints:
Length: 1 - 15
Pattern: \d+

identityPoolId

java.lang.String identityPoolId

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

logins

java.util.Map<java.lang.String,java.lang.String> logins

A set of optional name-value pairs that map provider names to provider tokens. The available provider names for Logins are as follows:

• Facebook: graph.facebook.com

• Amazon Cognito user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID> , for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

• Google: accounts.google.com

• Amazon: www.amazon.com

• Twitter: api.twitter.com

• Digits: www.digits.com

Class com.amazonaws.services.cognitoidentity.model.GetIdResult extends java.lang.Object implements Serializable

Serialized Fields

identityId

java.lang.String identityId

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Class com.amazonaws.services.cognitoidentity.model.GetOpenIdTokenForDeveloperIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityId

java.lang.String identityId

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

identityPoolId

java.lang.String identityPoolId

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

logins

java.util.Map<java.lang.String,java.lang.String> logins

A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax "developer_provider_name": "developer_user_identifier". The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.

principalTags

java.util.Map<java.lang.String,java.lang.String> principalTags

Use this operation to configure attribute mappings for custom providers.

tokenDuration

java.lang.Long tokenDuration

The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.

Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.

Constraints:
Range: 1 - 86400

Class com.amazonaws.services.cognitoidentity.model.GetOpenIdTokenForDeveloperIdentityResult extends java.lang.Object implements Serializable

Serialized Fields

identityId

java.lang.String identityId

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

token

java.lang.String token

An OpenID token.

Class com.amazonaws.services.cognitoidentity.model.GetOpenIdTokenRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityId

java.lang.String identityId

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

logins

java.util.Map<java.lang.String,java.lang.String> logins

A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com, an Amazon Cognito user pool provider, or any other OpenID Connect provider, always include the id_token.

Class com.amazonaws.services.cognitoidentity.model.GetOpenIdTokenResult extends java.lang.Object implements Serializable

Serialized Fields

identityId

java.lang.String identityId

A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

token

java.lang.String token

An OpenID token, valid for 10 minutes.

Class com.amazonaws.services.cognitoidentity.model.GetPrincipalTagAttributeMapRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityPoolId

java.lang.String identityPoolId

You can use this operation to get the ID of the Identity Pool you setup attribute mappings for.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

identityProviderName

java.lang.String identityProviderName

You can use this operation to get the provider name.

Constraints:
Length: 1 - 128

Class com.amazonaws.services.cognitoidentity.model.GetPrincipalTagAttributeMapResult extends java.lang.Object implements Serializable

Serialized Fields

identityPoolId

java.lang.String identityPoolId

You can use this operation to get the ID of the Identity Pool you setup attribute mappings for.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

identityProviderName

java.lang.String identityProviderName

You can use this operation to get the provider name.

Constraints:
Length: 1 - 128

principalTags

java.util.Map<java.lang.String,java.lang.String> principalTags

You can use this operation to add principal tags. The PrincipalTagsoperation enables you to reference user attributes in your IAM permissions policy.

useDefaults

java.lang.Boolean useDefaults

You can use this operation to list

Class com.amazonaws.services.cognitoidentity.model.IdentityDescription extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

Date on which the identity was created.

identityId

java.lang.String identityId

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

lastModifiedDate

java.util.Date lastModifiedDate

Date on which the identity was last modified.

logins

java.util.List<java.lang.String> logins

The provider names.

Class com.amazonaws.services.cognitoidentity.model.IdentityPoolShortDescription extends java.lang.Object implements Serializable

Serialized Fields

identityPoolId

java.lang.String identityPoolId

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

identityPoolName

java.lang.String identityPoolName

A string that you provide.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

Class com.amazonaws.services.cognitoidentity.model.InternalErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentity.model.InvalidIdentityPoolConfigurationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentity.model.InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentity.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentity.model.ListIdentitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

hideDisabled

java.lang.Boolean hideDisabled

An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

identityPoolId

java.lang.String identityPoolId

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

maxResults

java.lang.Integer maxResults

The maximum number of identities to return.

Constraints:
Range: 1 - 60

nextToken

java.lang.String nextToken

A pagination token.

Constraints:
Length: 1 - 65535
Pattern: [\S]+

Class com.amazonaws.services.cognitoidentity.model.ListIdentitiesResult extends java.lang.Object implements Serializable

Serialized Fields

identities

java.util.List<IdentityDescription> identities

An object containing a set of identities and associated mappings.

identityPoolId

java.lang.String identityPoolId

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

nextToken

java.lang.String nextToken

A pagination token.

Constraints:
Length: 1 - 65535
Pattern: [\S]+

Class com.amazonaws.services.cognitoidentity.model.ListIdentityPoolsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of identities to return.

Constraints:
Range: 1 - 60

nextToken

java.lang.String nextToken

A pagination token.

Constraints:
Length: 1 - 65535
Pattern: [\S]+

Class com.amazonaws.services.cognitoidentity.model.ListIdentityPoolsResult extends java.lang.Object implements Serializable

Serialized Fields

identityPools

java.util.List<IdentityPoolShortDescription> identityPools

The identity pools returned by the ListIdentityPools action.

nextToken

java.lang.String nextToken

A pagination token.

Constraints:
Length: 1 - 65535
Pattern: [\S]+

Class com.amazonaws.services.cognitoidentity.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.cognitoidentity.model.ListTagsForResourceResult extends java.lang.Object implements Serializable

Serialized Fields

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags that are assigned to the identity pool.

Class com.amazonaws.services.cognitoidentity.model.LookupDeveloperIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

developerUserIdentifier

java.lang.String developerUserIdentifier

A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.

Constraints:
Length: 1 - 1024

identityId

java.lang.String identityId

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

identityPoolId

java.lang.String identityPoolId

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

maxResults

java.lang.Integer maxResults

The maximum number of identities to return.

Constraints:
Range: 1 - 60

nextToken

java.lang.String nextToken

A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.

Constraints:
Length: 1 - 65535
Pattern: [\S]+

Class com.amazonaws.services.cognitoidentity.model.LookupDeveloperIdentityResult extends java.lang.Object implements Serializable

Serialized Fields

developerUserIdentifierList

java.util.List<java.lang.String> developerUserIdentifierList

This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.

identityId

java.lang.String identityId

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

nextToken

java.lang.String nextToken

A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.

Constraints:
Length: 1 - 65535
Pattern: [\S]+

Class com.amazonaws.services.cognitoidentity.model.MappingRule extends java.lang.Object implements Serializable

Serialized Fields

claim

java.lang.String claim

The claim name that must be present in the token, for example, "isAdmin" or "paid".

Constraints:
Length: 1 - 64
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

matchType

java.lang.String matchType

The match condition that specifies how closely the claim value in the IdP token must match Value.

Constraints:
Allowed Values: Equals, Contains, StartsWith, NotEqual

roleARN

java.lang.String roleARN

The role ARN.

Constraints:
Length: 20 - 2048

value

java.lang.String value

A brief string that the claim must match, for example, "paid" or "yes".

Constraints:
Length: 1 - 128

Class com.amazonaws.services.cognitoidentity.model.MergeDeveloperIdentitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationUserIdentifier

java.lang.String destinationUserIdentifier

User identifier for the destination user. The value should be a DeveloperUserIdentifier.

Constraints:
Length: 1 - 1024

developerProviderName

java.lang.String developerProviderName

The "domain" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

Constraints:
Length: 1 - 128
Pattern: [\w._-]+

identityPoolId

java.lang.String identityPoolId

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

sourceUserIdentifier

java.lang.String sourceUserIdentifier

User identifier for the source user. The value should be a DeveloperUserIdentifier.

Constraints:
Length: 1 - 1024

Class com.amazonaws.services.cognitoidentity.model.MergeDeveloperIdentitiesResult extends java.lang.Object implements Serializable

Serialized Fields

identityId

java.lang.String identityId

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Class com.amazonaws.services.cognitoidentity.model.NotAuthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentity.model.ResourceConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentity.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentity.model.RoleMapping extends java.lang.Object implements Serializable

Serialized Fields

ambiguousRoleResolution

java.lang.String ambiguousRoleResolution

If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

Constraints:
Allowed Values: AuthenticatedRole, Deny

rulesConfiguration

RulesConfigurationType rulesConfiguration

The rules to be used for mapping users to roles.

If you specify Rules as the role mapping type, RulesConfiguration is required.

type

java.lang.String type

The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

Constraints:
Allowed Values: Token, Rules

Class com.amazonaws.services.cognitoidentity.model.RulesConfigurationType extends java.lang.Object implements Serializable

Serialized Fields

rules

java.util.List<MappingRule> rules

An array of rules. You can specify up to 25 rules per identity provider.

Rules are evaluated in order. The first one to match specifies the role.

Class com.amazonaws.services.cognitoidentity.model.SetIdentityPoolRolesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityPoolId

java.lang.String identityPoolId

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

roleMappings

java.util.Map<java.lang.String,RoleMapping> roleMappings

How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".

Up to 25 rules can be specified per identity provider.

roles

java.util.Map<java.lang.String,java.lang.String> roles

The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.

Class com.amazonaws.services.cognitoidentity.model.SetPrincipalTagAttributeMapRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityPoolId

java.lang.String identityPoolId

The ID of the Identity Pool you want to set attribute mappings for.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

identityProviderName

java.lang.String identityProviderName

The provider name you want to use for attribute mappings.

Constraints:
Length: 1 - 128

principalTags

java.util.Map<java.lang.String,java.lang.String> principalTags

You can use this operation to add principal tags.

useDefaults

java.lang.Boolean useDefaults

You can use this operation to use default (username and clientID) attribute mappings.

Class com.amazonaws.services.cognitoidentity.model.SetPrincipalTagAttributeMapResult extends java.lang.Object implements Serializable

Serialized Fields

identityPoolId

java.lang.String identityPoolId

The ID of the Identity Pool you want to set attribute mappings for.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

identityProviderName

java.lang.String identityProviderName

The provider name you want to use for attribute mappings.

Constraints:
Length: 1 - 128

principalTags

java.util.Map<java.lang.String,java.lang.String> principalTags

You can use this operation to add principal tags. The PrincipalTagsoperation enables you to reference user attributes in your IAM permissions policy.

useDefaults

java.lang.Boolean useDefaults

You can use this operation to select default (username and clientID) attribute mappings.

Class com.amazonaws.services.cognitoidentity.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the identity pool.

Constraints:
Length: 20 - 2048

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags to assign to the identity pool.

Class com.amazonaws.services.cognitoidentity.model.TagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentity.model.TooManyRequestsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentity.model.UnlinkDeveloperIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

developerProviderName

java.lang.String developerProviderName

The "domain" by which Cognito will refer to your users.

Constraints:
Length: 1 - 128
Pattern: [\w._-]+

developerUserIdentifier

java.lang.String developerUserIdentifier

A unique ID used by your backend authentication process to identify a user.

Constraints:
Length: 1 - 1024

identityId

java.lang.String identityId

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

identityPoolId

java.lang.String identityPoolId

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Class com.amazonaws.services.cognitoidentity.model.UnlinkIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityId

java.lang.String identityId

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

logins

java.util.Map<java.lang.String,java.lang.String> logins

A set of optional name-value pairs that map provider names to provider tokens.

loginsToRemove

java.util.List<java.lang.String> loginsToRemove

Provider names to unlink from this identity.

Class com.amazonaws.services.cognitoidentity.model.UnprocessedIdentityId extends java.lang.Object implements Serializable

Serialized Fields

errorCode

java.lang.String errorCode

The error code indicating the type of error that occurred.

Constraints:
Allowed Values: AccessDenied, InternalServerError

identityId

java.lang.String identityId

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Class com.amazonaws.services.cognitoidentity.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the identity pool.

Constraints:
Length: 20 - 2048

tagKeys

java.util.List<java.lang.String> tagKeys

The keys of the tags to remove from the user pool.

Class com.amazonaws.services.cognitoidentity.model.UntagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentity.model.UpdateIdentityPoolRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

allowClassicFlow

java.lang.Boolean allowClassicFlow

Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

allowUnauthenticatedIdentities

java.lang.Boolean allowUnauthenticatedIdentities

TRUE if the identity pool supports unauthenticated logins.

cognitoIdentityProviders

java.util.List<CognitoIdentityProvider> cognitoIdentityProviders

A list representing an Amazon Cognito user pool and its client ID.

developerProviderName

java.lang.String developerProviderName

The "domain" by which Cognito will refer to your users.

Constraints:
Length: 1 - 128
Pattern: [\w._-]+

identityPoolId

java.lang.String identityPoolId

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

identityPoolName

java.lang.String identityPoolName

A string that you provide.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

identityPoolTags

java.util.Map<java.lang.String,java.lang.String> identityPoolTags

The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

openIdConnectProviderARNs

java.util.List<java.lang.String> openIdConnectProviderARNs

The ARNs of the OpenID Connect providers.

samlProviderARNs

java.util.List<java.lang.String> samlProviderARNs

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

supportedLoginProviders

java.util.Map<java.lang.String,java.lang.String> supportedLoginProviders

Optional key:value pairs mapping provider names to provider app IDs.

Class com.amazonaws.services.cognitoidentity.model.UpdateIdentityPoolResult extends java.lang.Object implements Serializable

Serialized Fields

allowClassicFlow

java.lang.Boolean allowClassicFlow

Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

allowUnauthenticatedIdentities

java.lang.Boolean allowUnauthenticatedIdentities

TRUE if the identity pool supports unauthenticated logins.

cognitoIdentityProviders

java.util.List<CognitoIdentityProvider> cognitoIdentityProviders

A list representing an Amazon Cognito user pool and its client ID.

developerProviderName

java.lang.String developerProviderName

The "domain" by which Cognito will refer to your users.

Constraints:
Length: 1 - 128
Pattern: [\w._-]+

identityPoolId

java.lang.String identityPoolId

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

identityPoolName

java.lang.String identityPoolName

A string that you provide.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

identityPoolTags

java.util.Map<java.lang.String,java.lang.String> identityPoolTags

The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

openIdConnectProviderARNs

java.util.List<java.lang.String> openIdConnectProviderARNs

The ARNs of the OpenID Connect providers.

samlProviderARNs

java.util.List<java.lang.String> samlProviderARNs

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

supportedLoginProviders

java.util.Map<java.lang.String,java.lang.String> supportedLoginProviders

Optional key:value pairs mapping provider names to provider app IDs.

Package com.amazonaws.services.cognitoidentityprovider.model

Class com.amazonaws.services.cognitoidentityprovider.model.AccountRecoverySettingType extends java.lang.Object implements Serializable

Serialized Fields

recoveryMechanisms

java.util.List<RecoveryOptionType> recoveryMechanisms

The list of RecoveryOptionTypes.

Class com.amazonaws.services.cognitoidentityprovider.model.AccountTakeoverActionsType extends java.lang.Object implements Serializable

Serialized Fields

highAction

AccountTakeoverActionType highAction

Action to take for a high risk.

lowAction

AccountTakeoverActionType lowAction

Action to take for a low risk.

mediumAction

AccountTakeoverActionType mediumAction

Action to take for a medium risk.

Class com.amazonaws.services.cognitoidentityprovider.model.AccountTakeoverActionType extends java.lang.Object implements Serializable

Serialized Fields

eventAction

java.lang.String eventAction

The action to take in response to the account takeover action. Valid values are as follows:

• BLOCK Choosing this action will block the request.

• MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else allow the request.

• MFA_REQUIRED Present an MFA challenge if user has configured it, else block the request.

• NO_ACTION Allow the user to sign in.

Constraints:
Allowed Values: BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION

notify

java.lang.Boolean notify

Flag specifying whether to send a notification.

Class com.amazonaws.services.cognitoidentityprovider.model.AccountTakeoverRiskConfigurationType extends java.lang.Object implements Serializable

Serialized Fields

actions

AccountTakeoverActionsType actions

Account takeover risk configuration actions.

notifyConfiguration

NotifyConfigurationType notifyConfiguration

The notify configuration used to construct email notifications.

Class com.amazonaws.services.cognitoidentityprovider.model.AddCustomAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customAttributes

java.util.List<SchemaAttributeType> customAttributes

An array of custom attributes, such as Mutable and Name.

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool where you want to add custom attributes.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AddCustomAttributesResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.AdminAddUserToGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

java.lang.String groupName

The group name.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

username

java.lang.String username

The username for the user.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminConfirmSignUpRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientMetadata

java.util.Map<java.lang.String,java.lang.String> clientMetadata

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in Lambda, you can process the ClientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

username

java.lang.String username

The user name for which you want to confirm user registration.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID for which you want to confirm user registration.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminConfirmSignUpResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.AdminCreateUserConfigType extends java.lang.Object implements Serializable

Serialized Fields

allowAdminCreateUserOnly

java.lang.Boolean allowAdminCreateUserOnly

Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.

inviteMessageTemplate

MessageTemplateType inviteMessageTemplate

The message template to be used for the welcome message to new users.

See also Customizing User Invitation Messages.

unusedAccountValidityDays

java.lang.Integer unusedAccountValidityDays

The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7.

If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used, and UnusedAccountValidityDays will be no longer be an available parameter for that user pool.

Constraints:
Range: 0 - 365

Class com.amazonaws.services.cognitoidentityprovider.model.AdminCreateUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientMetadata

java.util.Map<java.lang.String,java.lang.String> clientMetadata

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

desiredDeliveryMediums

java.util.List<java.lang.String> desiredDeliveryMediums

Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". You can specify more than one value.

forceAliasCreation

java.lang.Boolean forceAliasCreation

This parameter is used only if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.

If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.

If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.

messageAction

java.lang.String messageAction

Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to SUPPRESS to suppress sending the message. You can specify only one value.

Constraints:
Allowed Values: RESEND, SUPPRESS

temporaryPassword

java.lang.String temporaryPassword

The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.

The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.

This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.

The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter.

Constraints:
Length: - 256
Pattern: [\S]+

userAttributes

java.util.List<AttributeType> userAttributes

An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser) or the user should supply (when they sign up in response to your welcome message).

For custom attributes, you must prepend the custom: prefix to the attribute name.

To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.

In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True . You can also do this by calling AdminUpdateUserAttributes.

• email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.

• phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.

username

java.lang.String username

The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can't be changed.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool where the user will be created.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

validationData

java.util.List<AttributeType> validationData

The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.

To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.

The user's validation data isn't persisted.

Class com.amazonaws.services.cognitoidentityprovider.model.AdminCreateUserResult extends java.lang.Object implements Serializable

Serialized Fields

user

UserType user

The newly created user.

Class com.amazonaws.services.cognitoidentityprovider.model.AdminDeleteUserAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userAttributeNames

java.util.List<java.lang.String> userAttributeNames

An array of strings representing the user attribute names you want to delete.

For custom attributes, you must prepend the custom: prefix to the attribute name.

username

java.lang.String username

The user name of the user from which you would like to delete attributes.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool where you want to delete user attributes.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminDeleteUserAttributesResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.AdminDeleteUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

username

java.lang.String username

The user name of the user you want to delete.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool where you want to delete the user.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminDisableProviderForUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

user

ProviderUserIdentifierType user

The user to be disabled.

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Class com.amazonaws.services.cognitoidentityprovider.model.AdminDisableProviderForUserResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.AdminDisableUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

username

java.lang.String username

The user name of the user you want to disable.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool where you want to disable the user.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminDisableUserResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.AdminEnableUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

username

java.lang.String username

The user name of the user you want to enable.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool where you want to enable the user.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminEnableUserResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.AdminForgetDeviceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deviceKey

java.lang.String deviceKey

The device key.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-f-]+

username

java.lang.String username

The user name.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminGetDeviceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deviceKey

java.lang.String deviceKey

The device key.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-f-]+

username

java.lang.String username

The user name.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminGetDeviceResult extends java.lang.Object implements Serializable

Serialized Fields

device

DeviceType device

The device.

Class com.amazonaws.services.cognitoidentityprovider.model.AdminGetUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

username

java.lang.String username

The user name of the user you want to retrieve.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool where you want to get information about the user.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminGetUserResult extends java.lang.Object implements Serializable

Serialized Fields

enabled

java.lang.Boolean enabled

Indicates that the status is enabled.

mFAOptions

java.util.List<MFAOptionType> mFAOptions

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

preferredMfaSetting

java.lang.String preferredMfaSetting

The user's preferred MFA setting.

userAttributes

java.util.List<AttributeType> userAttributes

An array of name-value pairs representing user attributes.

userCreateDate

java.util.Date userCreateDate

The date the user was created.

userLastModifiedDate

java.util.Date userLastModifiedDate

The date the user was last modified.

userMFASettingList

java.util.List<java.lang.String> userMFASettingList

The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

username

java.lang.String username

The user name of the user about whom you're receiving information.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userStatus

java.lang.String userStatus

The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• ARCHIVED - User is no longer active.

• UNKNOWN - User status isn't known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.

• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.

Constraints:
Allowed Values: UNCONFIRMED, CONFIRMED, ARCHIVED, COMPROMISED, UNKNOWN, RESET_REQUIRED, FORCE_CHANGE_PASSWORD

Class com.amazonaws.services.cognitoidentityprovider.model.AdminInitiateAuthRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

analyticsMetadata

AnalyticsMetadataType analyticsMetadata

The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.

authFlow

java.lang.String authFlow

The authentication flow for this call to run. The API action will depend on this value. For example:

• REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.

• USER_SRP_AUTH will take in USERNAME and SRP_A and return the Secure Remote Password (SRP) protocol variables to be used for next challenge execution.

• ADMIN_USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.

Valid values include:

• USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.

• REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.

• CUSTOM_AUTH: Custom authentication flow.

• ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.

• ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Amazon Cognito receives the password in the request instead of using the SRP process to verify passwords.

Constraints:
Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH, ADMIN_USER_PASSWORD_AUTH

authParameters

java.util.Map<java.lang.String,java.lang.String> authParameters

The authentication parameters. These are inputs corresponding to the AuthFlow that you're invoking. The required values depend on the value of AuthFlow:

• For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.

• For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.

• For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY.

• For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).

clientId

java.lang.String clientId

The app client ID.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

clientMetadata

java.util.Map<java.lang.String,java.lang.String> clientMetadata

A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:

• Pre signup

• Pre authentication

• User migration

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.

When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:

• Post authentication

• Custom message

• Pre token generation

• Create auth challenge

• Define auth challenge

• Verify auth challenge

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

contextData

ContextDataType contextData

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

userPoolId

java.lang.String userPoolId

The ID of the Amazon Cognito user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminInitiateAuthResult extends java.lang.Object implements Serializable

Serialized Fields

authenticationResult

AuthenticationResultType authenticationResult

The result of the authentication response. This is only returned if the caller doesn't need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.

challengeName

java.lang.String challengeName

The name of the challenge that you're responding to with this call. This is returned in the AdminInitiateAuth response if you must pass another challenge.

• MFA_SETUP: If MFA is required, users who don't have at least one of the MFA methods set up are presented with an MFA_SETUP challenge. The user must set up at least one MFA type to continue to authenticate.

• SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA for text SMS MFA, and SOFTWARE_TOKEN_MFA for time-based one-time password (TOTP) software token MFA.

• SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.

• PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.

• CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.

• DEVICE_SRP_AUTH: If device tracking was activated in your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.

• DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.

• ADMIN_NO_SRP_AUTH: This is returned if you must authenticate with USERNAME and PASSWORD directly. An app client must be enabled to use this flow.

• NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. Respond to this challenge with NEW_PASSWORD and any required attributes that Amazon Cognito returned in the requiredAttributes parameter. You can also set values for attributes that aren't required by your user pool and that your app client can write. For more information, see AdminRespondToAuthChallenge.

  In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.

• MFA_SETUP: For users who are required to set up an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.

  To set up software token MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken, and use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS MFA, users will need help from an administrator to add a phone number to their account and then call InitiateAuth again to restart sign-in.

Constraints:
Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED

challengeParameters

java.util.Map<java.lang.String,java.lang.String> challengeParameters

The challenge parameters. These are returned to you in the AdminInitiateAuth response if you must pass another challenge. The responses in this parameter should be used to compute inputs to the next call (AdminRespondToAuthChallenge).

All challenges require USERNAME and SECRET_HASH (if applicable).

The value of the USER_ID_FOR_SRP attribute is the user's actual username, not an alias (such as email address or phone number), even if you specified an alias in your call to AdminInitiateAuth. This happens because, in the AdminRespondToAuthChallenge API ChallengeResponses, the USERNAME attribute can't be an alias.

session

java.lang.String session

The session that should be passed both ways in challenge-response calls to the service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next AdminRespondToAuthChallenge API call.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.cognitoidentityprovider.model.AdminLinkProviderForUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationUser

ProviderUserIdentifierType destinationUser

The existing user in the user pool that you want to assign to the external IdP user account. This user can be a native (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP attribute) signs in.

For a native username + password user, the ProviderAttributeValue for the DestinationUser should be the username in the user pool. For a federated user, it should be the provider-specific user_id.

The ProviderAttributeName of the DestinationUser is ignored.

The ProviderName should be set to Cognito for users in Cognito user pools.

All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.

sourceUser

ProviderUserIdentifierType sourceUser

An external IdP account for a user who doesn't exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.

If the SourceUser is using a federated social IdP, such as Facebook, Google, or Login with Amazon, you must set the ProviderAttributeName to Cognito_Subject. For social IdPs, the ProviderName will be Facebook, Google, or LoginWithAmazon, and Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for id, sub, and user_id, respectively. The ProviderAttributeValue for the user must be the same value as the id, sub, or user_id value found in the social IdP token.

For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. If you want to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML IdP and submit that claim name as the ProviderAttributeName. If you set ProviderAttributeName to Cognito_Subject, Amazon Cognito will automatically parse the default unique identifier found in the subject from the SAML token.

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Class com.amazonaws.services.cognitoidentityprovider.model.AdminLinkProviderForUserResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.AdminListDevicesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

limit

java.lang.Integer limit

The limit of the devices request.

Constraints:
Range: 0 - 60

paginationToken

java.lang.String paginationToken

The pagination token.

Constraints:
Length: 1 -
Pattern: [\S]+

username

java.lang.String username

The user name.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminListDevicesResult extends java.lang.Object implements Serializable

Serialized Fields

devices

java.util.List<DeviceType> devices

The devices in the list of devices response.

paginationToken

java.lang.String paginationToken

The pagination token.

Constraints:
Length: 1 -
Pattern: [\S]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminListGroupsForUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

limit

java.lang.Integer limit

The limit of the request to list groups.

Constraints:
Range: 0 - 60

nextToken

java.lang.String nextToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Constraints:
Length: 1 -
Pattern: [\S]+

username

java.lang.String username

The username for the user.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminListGroupsForUserResult extends java.lang.Object implements Serializable

Serialized Fields

groups

java.util.List<GroupType> groups

The groups that the user belongs to.

nextToken

java.lang.String nextToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Constraints:
Length: 1 -
Pattern: [\S]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminListUserAuthEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of authentication events to return.

Constraints:
Range: 0 - 60

nextToken

java.lang.String nextToken

A pagination token.

Constraints:
Length: 1 -
Pattern: [\S]+

username

java.lang.String username

The user pool username or an alias.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminListUserAuthEventsResult extends java.lang.Object implements Serializable

Serialized Fields

authEvents

java.util.List<AuthEventType> authEvents

The response object. It includes the EventID, EventType, CreationDate, EventRisk , and EventResponse.

nextToken

java.lang.String nextToken

A pagination token.

Constraints:
Length: 1 -
Pattern: [\S]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminRemoveUserFromGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

java.lang.String groupName

The group name.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

username

java.lang.String username

The username for the user.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminResetUserPasswordRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientMetadata

java.util.Map<java.lang.String,java.lang.String> clientMetadata

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

username

java.lang.String username

The user name of the user whose password you want to reset.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool where you want to reset the user's password.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminResetUserPasswordResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.AdminRespondToAuthChallengeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

analyticsMetadata

AnalyticsMetadataType analyticsMetadata

The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.

challengeName

java.lang.String challengeName

The challenge name. For more information, see AdminInitiateAuth.

Constraints:
Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED

challengeResponses

java.util.Map<java.lang.String,java.lang.String> challengeResponses

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

• SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).

• PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).

  PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.

• ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).

• NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the AdminInitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.

  In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.

• MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.

The value of the USERNAME attribute must be the user's actual username, not an alias (such as an email address or phone number). To make this simpler, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias in your call to AdminInitiateAuth.

clientId

java.lang.String clientId

The app client ID.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

clientMetadata

java.util.Map<java.lang.String,java.lang.String> clientMetadata

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:

• pre sign-up

• custom message

• post authentication

• user migration

• pre token generation

• define auth challenge

• create auth challenge

• verify auth challenge response

When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

contextData

ContextDataType contextData

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

session

java.lang.String session

The session that should be passed both ways in challenge-response calls to the service. If an InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Constraints:
Length: 20 - 2048

userPoolId

java.lang.String userPoolId

The ID of the Amazon Cognito user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminRespondToAuthChallengeResult extends java.lang.Object implements Serializable

Serialized Fields

authenticationResult

AuthenticationResultType authenticationResult

The result returned by the server in response to the authentication request.

challengeName

java.lang.String challengeName

The name of the challenge. For more information, see AdminInitiateAuth.

Constraints:
Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED

challengeParameters

java.util.Map<java.lang.String,java.lang.String> challengeParameters

The challenge parameters. For more information, see AdminInitiateAuth.

session

java.lang.String session

The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.cognitoidentityprovider.model.AdminSetUserMFAPreferenceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sMSMfaSettings

SMSMfaSettingsType sMSMfaSettings

The SMS text message MFA settings.

softwareTokenMfaSettings

SoftwareTokenMfaSettingsType softwareTokenMfaSettings

The time-based one-time password software token MFA settings.

username

java.lang.String username

The user pool username or alias.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminSetUserMFAPreferenceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.AdminSetUserPasswordRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

password

java.lang.String password

The password for the user.

Constraints:
Length: - 256
Pattern: [\S]+

permanent

java.lang.Boolean permanent

True if the password is permanent, False if it is temporary.

username

java.lang.String username

The user name of the user whose password you want to set.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool where you want to set the user's password.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminSetUserPasswordResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.AdminSetUserSettingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

mFAOptions

java.util.List<MFAOptionType> mFAOptions

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

username

java.lang.String username

The user name of the user whose options you're setting.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The ID of the user pool that contains the user whose options you're setting.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminSetUserSettingsResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.AdminUpdateAuthEventFeedbackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

eventId

java.lang.String eventId

The authentication event ID.

Constraints:
Length: 1 - 50
Pattern: [\w+-]+

feedbackValue

java.lang.String feedbackValue

The authentication event feedback value.

Constraints:
Allowed Values: Valid, Invalid

username

java.lang.String username

The user pool username.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminUpdateAuthEventFeedbackResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.AdminUpdateDeviceStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deviceKey

java.lang.String deviceKey

The device key.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-f-]+

deviceRememberedStatus

java.lang.String deviceRememberedStatus

The status indicating whether a device has been remembered or not.

Constraints:
Allowed Values: remembered, not_remembered

username

java.lang.String username

The user name.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminUpdateDeviceStatusResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.AdminUpdateUserAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientMetadata

java.util.Map<java.lang.String,java.lang.String> clientMetadata

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

userAttributes

java.util.List<AttributeType> userAttributes

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.

To update the value of an attribute that requires verification in the same API request, include the email_verified or phone_number_verified attribute, with a value of true. If you set the email_verified or phone_number_verified value for an email or phone_number attribute that requires verification to true, Amazon Cognito doesn’t send a verification message to your user.

username

java.lang.String username

The user name of the user for whom you want to update user attributes.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool where you want to update user attributes.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminUpdateUserAttributesResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.AdminUserGlobalSignOutRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

username

java.lang.String username

The user name.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.AdminUserGlobalSignOutResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.AliasExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.AnalyticsConfigurationType extends java.lang.Object implements Serializable

Serialized Fields

applicationArn

java.lang.String applicationArn

The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

applicationId

java.lang.String applicationId

The application ID for an Amazon Pinpoint application.

Constraints:
Pattern: ^[0-9a-fA-F]+$

externalId

java.lang.String externalId

The external ID.

roleArn

java.lang.String roleArn

The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

userDataShared

java.lang.Boolean userDataShared

If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

Class com.amazonaws.services.cognitoidentityprovider.model.AnalyticsMetadataType extends java.lang.Object implements Serializable

Serialized Fields

analyticsEndpointId

java.lang.String analyticsEndpointId

The endpoint ID.

Class com.amazonaws.services.cognitoidentityprovider.model.AssociateSoftwareTokenRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A valid access token that Amazon Cognito issued to the user whose software token you want to generate.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

session

java.lang.String session

The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.cognitoidentityprovider.model.AssociateSoftwareTokenResult extends java.lang.Object implements Serializable

Serialized Fields

secretCode

java.lang.String secretCode

A unique generated shared secret code that is used in the TOTP algorithm to generate a one-time code.

Constraints:
Length: 16 -
Pattern: [A-Za-z0-9]+

session

java.lang.String session

The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.cognitoidentityprovider.model.AttributeType extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the attribute.

Constraints:
Length: 1 - 32
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

value

java.lang.String value

The value of the attribute.

Constraints:
Length: - 2048

Class com.amazonaws.services.cognitoidentityprovider.model.AuthenticationResultType extends java.lang.Object implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A valid access token that Amazon Cognito issued to the user who you want to authenticate.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

expiresIn

java.lang.Integer expiresIn

The expiration period of the authentication result in seconds.

idToken

java.lang.String idToken

The ID token.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

newDeviceMetadata

NewDeviceMetadataType newDeviceMetadata

The new device metadata from an authentication result.

refreshToken

java.lang.String refreshToken

The refresh token.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

tokenType

java.lang.String tokenType

The token type.

Class com.amazonaws.services.cognitoidentityprovider.model.AuthEventType extends java.lang.Object implements Serializable

Serialized Fields

challengeResponses

java.util.List<ChallengeResponseType> challengeResponses

The challenge responses.

creationDate

java.util.Date creationDate

The creation date

eventContextData

EventContextDataType eventContextData

The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.

eventFeedback

EventFeedbackType eventFeedback

A flag specifying the user feedback captured at the time of an event request is good or bad.

eventId

java.lang.String eventId

The event ID.

eventResponse

java.lang.String eventResponse

The event response.

Constraints:
Allowed Values: Pass, Fail, InProgress

eventRisk

EventRiskType eventRisk

The event risk.

eventType

java.lang.String eventType

The event type.

Constraints:
Allowed Values: SignIn, SignUp, ForgotPassword, PasswordChange, ResendCode

Class com.amazonaws.services.cognitoidentityprovider.model.ChallengeResponseType extends java.lang.Object implements Serializable

Serialized Fields

challengeName

java.lang.String challengeName

The challenge name.

Constraints:
Allowed Values: Password, Mfa

challengeResponse

java.lang.String challengeResponse

The challenge response.

Constraints:
Allowed Values: Success, Failure

Class com.amazonaws.services.cognitoidentityprovider.model.ChangePasswordRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A valid access token that Amazon Cognito issued to the user whose password you want to change.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

previousPassword

java.lang.String previousPassword

The old password.

Constraints:
Length: - 256
Pattern: [\S]+

proposedPassword

java.lang.String proposedPassword

The new password.

Constraints:
Length: - 256
Pattern: [\S]+

Class com.amazonaws.services.cognitoidentityprovider.model.ChangePasswordResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.CodeDeliveryDetailsType extends java.lang.Object implements Serializable

Serialized Fields

attributeName

java.lang.String attributeName

The name of the attribute that Amazon Cognito verifies with the code.

Constraints:
Length: 1 - 32
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

deliveryMedium

java.lang.String deliveryMedium

The method that Amazon Cognito used to send the code.

Constraints:
Allowed Values: SMS, EMAIL

destination

java.lang.String destination

The email address or phone number destination where Amazon Cognito sent the code.

Class com.amazonaws.services.cognitoidentityprovider.model.CodeDeliveryFailureException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.CodeMismatchException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.CompromisedCredentialsActionsType extends java.lang.Object implements Serializable

Serialized Fields

eventAction

java.lang.String eventAction

The event action.

Constraints:
Allowed Values: BLOCK, NO_ACTION

Class com.amazonaws.services.cognitoidentityprovider.model.CompromisedCredentialsRiskConfigurationType extends java.lang.Object implements Serializable

Serialized Fields

actions

CompromisedCredentialsActionsType actions

The compromised credentials risk configuration actions.

eventFilter

java.util.List<java.lang.String> eventFilter

Perform the action for these events. The default is to perform all events if no event filter is specified.

Class com.amazonaws.services.cognitoidentityprovider.model.ConcurrentModificationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.ConfirmDeviceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A valid access token that Amazon Cognito issued to the user whose device you want to confirm.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

deviceKey

java.lang.String deviceKey

The device key.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-f-]+

deviceName

java.lang.String deviceName

The device name.

Constraints:
Length: 1 - 1024

deviceSecretVerifierConfig

DeviceSecretVerifierConfigType deviceSecretVerifierConfig

The configuration of the device secret verifier.

Class com.amazonaws.services.cognitoidentityprovider.model.ConfirmDeviceResult extends java.lang.Object implements Serializable

Serialized Fields

userConfirmationNecessary

java.lang.Boolean userConfirmationNecessary

Indicates whether the user confirmation must confirm the device response.

Class com.amazonaws.services.cognitoidentityprovider.model.ConfirmForgotPasswordRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

analyticsMetadata

AnalyticsMetadataType analyticsMetadata

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

clientId

java.lang.String clientId

The app client ID of the app associated with the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

clientMetadata

java.util.Map<java.lang.String,java.lang.String> clientMetadata

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

confirmationCode

java.lang.String confirmationCode

The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.

Constraints:
Length: 1 - 2048
Pattern: [\S]+

password

java.lang.String password

The new password that your user wants to set.

Constraints:
Length: - 256
Pattern: [\S]+

secretHash

java.lang.String secretHash

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Constraints:
Length: 1 - 128
Pattern: [\w+=/]+

userContextData

UserContextDataType userContextData

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

username

java.lang.String username

The user name of the user for whom you want to enter a code to retrieve a forgotten password.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Class com.amazonaws.services.cognitoidentityprovider.model.ConfirmForgotPasswordResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.ConfirmSignUpRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

analyticsMetadata

AnalyticsMetadataType analyticsMetadata

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

clientId

java.lang.String clientId

The ID of the app client associated with the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

clientMetadata

java.util.Map<java.lang.String,java.lang.String> clientMetadata

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

confirmationCode

java.lang.String confirmationCode

The confirmation code sent by a user's request to confirm registration.

Constraints:
Length: 1 - 2048
Pattern: [\S]+

forceAliasCreation

java.lang.Boolean forceAliasCreation

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

secretHash

java.lang.String secretHash

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Constraints:
Length: 1 - 128
Pattern: [\w+=/]+

userContextData

UserContextDataType userContextData

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

username

java.lang.String username

The user name of the user whose registration you want to confirm.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Class com.amazonaws.services.cognitoidentityprovider.model.ConfirmSignUpResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.ContextDataType extends java.lang.Object implements Serializable

Serialized Fields

encodedData

java.lang.String encodedData

Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

httpHeaders

java.util.List<HttpHeader> httpHeaders

HttpHeaders received on your server in same order.

ipAddress

java.lang.String ipAddress

The source IP address of your user's device.

serverName

java.lang.String serverName

Your server endpoint where this API is invoked.

serverPath

java.lang.String serverPath

Your server path where this API is invoked.

Class com.amazonaws.services.cognitoidentityprovider.model.CreateGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

A string containing the description of the group.

Constraints:
Length: - 2048

groupName

java.lang.String groupName

The name of the group. Must be unique.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

precedence

java.lang.Integer precedence

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

The default Precedence value is null. The maximum Precedence value is 2^31-1.

Constraints:
Range: 0 -

roleArn

java.lang.String roleArn

The role Amazon Resource Name (ARN) for the group.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.CreateGroupResult extends java.lang.Object implements Serializable

Serialized Fields

group

GroupType group

The group object for the group.

Class com.amazonaws.services.cognitoidentityprovider.model.CreateIdentityProviderRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeMapping

java.util.Map<java.lang.String,java.lang.String> attributeMapping

A mapping of IdP attributes to standard and custom user pool attributes.

idpIdentifiers

java.util.List<java.lang.String> idpIdentifiers

A list of IdP identifiers.

providerDetails

java.util.Map<java.lang.String,java.lang.String> providerDetails

The IdP details. The following list describes the provider detail keys for each IdP type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

• For OpenID Connect (OIDC) providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

    • authorize_url

    • token_url

    • attributes_url

    • jwks_uri

  • Amazon Cognito sets the value of the following keys automatically. They are read-only.

    • attributes_url_add_attributes

• For SAML providers:

  • MetadataFile or MetadataURL

  • IDPSignout optional

providerName

java.lang.String providerName

The IdP name.

Constraints:
Length: 3 - 32
Pattern: [^_][\p{L}\p{M}\p{S}\p{N}\p{P}][^_]+

providerType

java.lang.String providerType

The IdP type.

Constraints:
Allowed Values: SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.CreateIdentityProviderResult extends java.lang.Object implements Serializable

Serialized Fields

identityProvider

IdentityProviderType identityProvider

The newly created IdP object.

Class com.amazonaws.services.cognitoidentityprovider.model.CreateResourceServerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identifier

java.lang.String identifier

A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as https://my-weather-api.example.com.

Constraints:
Length: 1 - 256
Pattern: [\x21\x23-\x5B\x5D-\x7E]+

name

java.lang.String name

A friendly name for the resource server.

Constraints:
Length: 1 - 256
Pattern: [\w\s+=,.@-]+

scopes

java.util.List<ResourceServerScopeType> scopes

A list of scopes. Each scope is a key-value map with the keys name and description.

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.CreateResourceServerResult extends java.lang.Object implements Serializable

Serialized Fields

resourceServer

ResourceServerType resourceServer

The newly created resource server.

Class com.amazonaws.services.cognitoidentityprovider.model.CreateUserImportJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cloudWatchLogsRoleArn

java.lang.String cloudWatchLogsRoleArn

The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

jobName

java.lang.String jobName

The job name for the user import job.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool that the users are being imported into.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.CreateUserImportJobResult extends java.lang.Object implements Serializable

Serialized Fields

userImportJob

UserImportJobType userImportJob

The job object that represents the user import job.

Class com.amazonaws.services.cognitoidentityprovider.model.CreateUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessTokenValidity

java.lang.Integer accessTokenValidity

The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours , your user can authorize access with their access token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

Constraints:
Range: 1 - 86400

allowedOAuthFlows

java.util.List<java.lang.String> allowedOAuthFlows

The allowed OAuth flows.

code

Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.

implicit

Issue the access token (and, optionally, ID token, based on scopes) directly to your user.

client_credentials

Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.

allowedOAuthFlowsUserPoolClient

java.lang.Boolean allowedOAuthFlowsUserPoolClient

Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.

allowedOAuthScopes

java.util.List<java.lang.String> allowedOAuthScopes

The allowed OAuth scopes. Possible values provided by OAuth are phone, email, openid, and profile. Possible values provided by Amazon Web Services are aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

analyticsConfiguration

AnalyticsConfigurationType analyticsConfiguration

The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.

In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

authSessionValidity

java.lang.Integer authSessionValidity

Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

Constraints:
Range: 3 - 15

callbackURLs

java.util.List<java.lang.String> callbackURLs

A list of allowed redirect (callback) URLs for the IdPs.

A redirect URI must:

• Be an absolute URI.

• Be registered with the authorization server.

• Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

clientName

java.lang.String clientName

The client name for the user pool client you would like to create.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

defaultRedirectURI

java.lang.String defaultRedirectURI

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

• Be an absolute URI.

• Be registered with the authorization server.

• Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Constraints:
Length: 1 - 1024
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

enablePropagateAdditionalUserContextData

java.lang.Boolean enablePropagateAdditionalUserContextData

Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.

enableTokenRevocation

java.lang.Boolean enableTokenRevocation

Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.

If you don't include this parameter, token revocation is automatically activated for the new user pool client.

explicitAuthFlows

java.util.List<java.lang.String> explicitAuthFlows

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are no longer supported, in favor of new names with the ALLOW_ prefix.

Values with ALLOW_ prefix must be used only along with the ALLOW_ prefix.

Valid values include:

ALLOW_ADMIN_USER_PASSWORD_AUTH

Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.

ALLOW_CUSTOM_AUTH

Enable Lambda trigger based authentication.

ALLOW_USER_PASSWORD_AUTH

Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

ALLOW_USER_SRP_AUTH

Enable SRP-based authentication.

ALLOW_REFRESH_TOKEN_AUTH

Enable the authflow that refreshes tokens.

If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH.

generateSecret

java.lang.Boolean generateSecret

Boolean to specify whether you want to generate a secret for the user pool client being created.

idTokenValidity

java.lang.Integer idTokenValidity

The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

Constraints:
Range: 1 - 86400

logoutURLs

java.util.List<java.lang.String> logoutURLs

A list of allowed logout URLs for the IdPs.

preventUserExistenceErrors

java.lang.String preventUserExistenceErrors

Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.

Valid values include:

• ENABLED - This prevents user existence-related errors.

• LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.

Constraints:
Allowed Values: LEGACY, ENABLED

readAttributes

java.util.List<java.lang.String> readAttributes

The read attributes.

refreshTokenValidity

java.lang.Integer refreshTokenValidity

The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days.

The default time unit for RefreshTokenValidity in an API request is days. You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.

Constraints:
Range: 0 - 315360000

supportedIdentityProviders

java.util.List<java.lang.String> supportedIdentityProviders

A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: COGNITO, Facebook, Google, SignInWithApple, and LoginWithAmazon. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP or MyOIDCIdP.

tokenValidityUnits

TokenValidityUnitsType tokenValidityUnits

The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool where you want to create a user pool client.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

writeAttributes

java.util.List<java.lang.String> writeAttributes

The user pool attributes that the app client can write to.

If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.

Class com.amazonaws.services.cognitoidentityprovider.model.CreateUserPoolClientResult extends java.lang.Object implements Serializable

Serialized Fields

userPoolClient

UserPoolClientType userPoolClient

The user pool client that was just created.

Class com.amazonaws.services.cognitoidentityprovider.model.CreateUserPoolDomainRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customDomainConfig

CustomDomainConfigType customDomainConfig

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.

For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

domain

java.lang.String domain

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

Constraints:
Length: 1 - 63
Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.CreateUserPoolDomainResult extends java.lang.Object implements Serializable

Serialized Fields

cloudFrontDomain

java.lang.String cloudFrontDomain

The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

Constraints:
Length: 1 - 63
Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

Class com.amazonaws.services.cognitoidentityprovider.model.CreateUserPoolRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountRecoverySetting

AccountRecoverySettingType accountRecoverySetting

The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

adminCreateUserConfig

AdminCreateUserConfigType adminCreateUserConfig

The configuration for AdminCreateUser requests.

aliasAttributes

java.util.List<java.lang.String> aliasAttributes

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

autoVerifiedAttributes

java.util.List<java.lang.String> autoVerifiedAttributes

The attributes to be auto-verified. Possible values: email, phone_number.

deviceConfiguration

DeviceConfigurationType deviceConfiguration

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

emailConfiguration

EmailConfigurationType emailConfiguration

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

emailVerificationMessage

java.lang.String emailVerificationMessage

This parameter is no longer used. See VerificationMessageTemplateType.

Constraints:
Length: 6 - 20000
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{ N}\p{P}\s*]*

emailVerificationSubject

java.lang.String emailVerificationSubject

This parameter is no longer used. See VerificationMessageTemplateType.

Constraints:
Length: 1 - 140
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+

lambdaConfig

LambdaConfigType lambdaConfig

The Lambda trigger configuration information for the new user pool.

In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission .

For adding permission using the CLI, see add-permission .

mfaConfiguration

java.lang.String mfaConfiguration

Specifies MFA configuration details.

Constraints:
Allowed Values: OFF, ON, OPTIONAL

policies

UserPoolPolicyType policies

The policies associated with the new user pool.

poolName

java.lang.String poolName

A string used to name the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

schema

java.util.List<SchemaAttributeType> schema

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

smsAuthenticationMessage

java.lang.String smsAuthenticationMessage

A string representing the SMS authentication message.

Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*

smsConfiguration

SmsConfigurationType smsConfiguration

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

smsVerificationMessage

java.lang.String smsVerificationMessage

This parameter is no longer used. See VerificationMessageTemplateType.

Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*

userAttributeUpdateSettings

UserAttributeUpdateSettingsType userAttributeUpdateSettings

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

usernameAttributes

java.util.List<java.lang.String> usernameAttributes

Specifies whether a user can use an email address or phone number as a username when they sign up.

usernameConfiguration

UsernameConfigurationType usernameConfiguration

Case sensitivity on the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

userPoolAddOns

UserPoolAddOnsType userPoolAddOns

Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

userPoolTags

java.util.Map<java.lang.String,java.lang.String> userPoolTags

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

verificationMessageTemplate

VerificationMessageTemplateType verificationMessageTemplate

The template for the verification message that the user sees when the app requests permission to access the user's information.

Class com.amazonaws.services.cognitoidentityprovider.model.CreateUserPoolResult extends java.lang.Object implements Serializable

Serialized Fields

userPool

UserPoolType userPool

A container for the user pool details.

Class com.amazonaws.services.cognitoidentityprovider.model.CustomDomainConfigType extends java.lang.Object implements Serializable

Serialized Fields

certificateArn

java.lang.String certificateArn

The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Class com.amazonaws.services.cognitoidentityprovider.model.CustomEmailLambdaVersionConfigType extends java.lang.Object implements Serializable

Serialized Fields

lambdaArn

java.lang.String lambdaArn

The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send email notifications to users.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

lambdaVersion

java.lang.String lambdaVersion

Signature of the "request" attribute in the "event" information Amazon Cognito passes to your custom email Lambda function. The only supported value is V1_0.

Constraints:
Allowed Values: V1_0

Class com.amazonaws.services.cognitoidentityprovider.model.CustomSMSLambdaVersionConfigType extends java.lang.Object implements Serializable

Serialized Fields

lambdaArn

java.lang.String lambdaArn

The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send SMS notifications to users.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

lambdaVersion

java.lang.String lambdaVersion

Signature of the "request" attribute in the "event" information that Amazon Cognito passes to your custom SMS Lambda function. The only supported value is V1_0.

Constraints:
Allowed Values: V1_0

Class com.amazonaws.services.cognitoidentityprovider.model.DeleteGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

java.lang.String groupName

The name of the group.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.DeleteIdentityProviderRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

providerName

java.lang.String providerName

The IdP name.

Constraints:
Length: 1 - 32
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.DeleteResourceServerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identifier

java.lang.String identifier

The identifier for the resource server.

Constraints:
Length: 1 - 256
Pattern: [\x21\x23-\x5B\x5D-\x7E]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool that hosts the resource server.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.DeleteUserAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

userAttributeNames

java.util.List<java.lang.String> userAttributeNames

An array of strings representing the user attribute names you want to delete.

For custom attributes, you must prependattach the custom: prefix to the front of the attribute name.

Class com.amazonaws.services.cognitoidentityprovider.model.DeleteUserAttributesResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.DeleteUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientId

java.lang.String clientId

The app client ID of the app associated with the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool where you want to delete the client.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.DeleteUserPoolDomainRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

java.lang.String domain

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

Constraints:
Length: 1 - 63
Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.DeleteUserPoolDomainResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.DeleteUserPoolRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool you want to delete.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A valid access token that Amazon Cognito issued to the user whose user profile you want to delete.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Class com.amazonaws.services.cognitoidentityprovider.model.DescribeIdentityProviderRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

providerName

java.lang.String providerName

The IdP name.

Constraints:
Length: 1 - 32
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.DescribeIdentityProviderResult extends java.lang.Object implements Serializable

Serialized Fields

identityProvider

IdentityProviderType identityProvider

The IdP that was deleted.

Class com.amazonaws.services.cognitoidentityprovider.model.DescribeResourceServerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identifier

java.lang.String identifier

The identifier for the resource server

Constraints:
Length: 1 - 256
Pattern: [\x21\x23-\x5B\x5D-\x7E]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool that hosts the resource server.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.DescribeResourceServerResult extends java.lang.Object implements Serializable

Serialized Fields

resourceServer

ResourceServerType resourceServer

The resource server.

Class com.amazonaws.services.cognitoidentityprovider.model.DescribeRiskConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientId

java.lang.String clientId

The app client ID.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.DescribeRiskConfigurationResult extends java.lang.Object implements Serializable

Serialized Fields

riskConfiguration

RiskConfigurationType riskConfiguration

The risk configuration.

Class com.amazonaws.services.cognitoidentityprovider.model.DescribeUserImportJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The job ID for the user import job.

Constraints:
Length: 1 - 55
Pattern: import-[0-9a-zA-Z-]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool that the users are being imported into.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.DescribeUserImportJobResult extends java.lang.Object implements Serializable

Serialized Fields

userImportJob

UserImportJobType userImportJob

The job object that represents the user import job.

Class com.amazonaws.services.cognitoidentityprovider.model.DescribeUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientId

java.lang.String clientId

The app client ID of the app associated with the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool you want to describe.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.DescribeUserPoolClientResult extends java.lang.Object implements Serializable

Serialized Fields

userPoolClient

UserPoolClientType userPoolClient

The user pool client from a server response to describe the user pool client.

Class com.amazonaws.services.cognitoidentityprovider.model.DescribeUserPoolDomainRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

java.lang.String domain

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

Constraints:
Length: 1 - 63
Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

Class com.amazonaws.services.cognitoidentityprovider.model.DescribeUserPoolDomainResult extends java.lang.Object implements Serializable

Serialized Fields

domainDescription

DomainDescriptionType domainDescription

A domain description object containing information about the domain.

Class com.amazonaws.services.cognitoidentityprovider.model.DescribeUserPoolRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool you want to describe.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.DescribeUserPoolResult extends java.lang.Object implements Serializable

Serialized Fields

userPool

UserPoolType userPool

The container of metadata returned by the server to describe the pool.

Class com.amazonaws.services.cognitoidentityprovider.model.DeviceConfigurationType extends java.lang.Object implements Serializable

Serialized Fields

challengeRequiredOnNewDevice

java.lang.Boolean challengeRequiredOnNewDevice

When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).

Whether or not ChallengeRequiredOnNewDevice is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.

deviceOnlyRememberedOnUserPrompt

java.lang.Boolean deviceOnlyRememberedOnUserPrompt

When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.

When DeviceOnlyRememberedOnUserPrompt is false, Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.

Class com.amazonaws.services.cognitoidentityprovider.model.DeviceSecretVerifierConfigType extends java.lang.Object implements Serializable

Serialized Fields

passwordVerifier

java.lang.String passwordVerifier

The password verifier.

salt

java.lang.String salt

The salt

Class com.amazonaws.services.cognitoidentityprovider.model.DeviceType extends java.lang.Object implements Serializable

Serialized Fields

deviceAttributes

java.util.List<AttributeType> deviceAttributes

The device attributes.

deviceCreateDate

java.util.Date deviceCreateDate

The creation date of the device.

deviceKey

java.lang.String deviceKey

The device key.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-f-]+

deviceLastAuthenticatedDate

java.util.Date deviceLastAuthenticatedDate

The date when the device was last authenticated.

deviceLastModifiedDate

java.util.Date deviceLastModifiedDate

The last modified date of the device.

Class com.amazonaws.services.cognitoidentityprovider.model.DomainDescriptionType extends java.lang.Object implements Serializable

Serialized Fields

aWSAccountId

java.lang.String aWSAccountId

The Amazon Web Services ID for the user pool owner.

cloudFrontDistribution

java.lang.String cloudFrontDistribution

The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.

customDomainConfig

CustomDomainConfigType customDomainConfig

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

domain

java.lang.String domain

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

Constraints:
Length: 1 - 63
Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

s3Bucket

java.lang.String s3Bucket

The Amazon S3 bucket where the static files for this domain are stored.

Constraints:
Length: 3 - 1024
Pattern: ^[0-9A-Za-z\.\-_]*(?

status

java.lang.String status

The domain status.

Constraints:
Allowed Values: CREATING, DELETING, UPDATING, ACTIVE, FAILED

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

version

java.lang.String version

The app version.

Constraints:
Length: 1 - 20

Class com.amazonaws.services.cognitoidentityprovider.model.DuplicateProviderException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.EmailConfigurationType extends java.lang.Object implements Serializable

Serialized Fields

configurationSet

java.lang.String configurationSet

The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails:

Event publishing

Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch

IP pool management

When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$

emailSendingAccount

java.lang.String emailSendingAccount

Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:

COGNITO_DEFAULT

When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.

To look up the email delivery limit for the default option, see Limits in in the Developer Guide.

The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the SourceArn parameter.

DEVELOPER

When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.

If you use this option, provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a type of role, in your Amazon Web Services account. This role contains the permissions that allow to access Amazon SES and send email messages with your address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.

Constraints:
Allowed Values: COGNITO_DEFAULT, DEVELOPER

from

java.lang.String from

Either the sender’s email address or the sender’s name with their email address. For example, testuser@example.com or Test User <testuser@example.com>. This address appears before the body of the email.

replyToEmailAddress

java.lang.String replyToEmailAddress

The destination to which the receiver of the email should reply.

Constraints:
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+@[\p{L}\p{M}\p{S}\p{N}\p{P}]+

sourceArn

java.lang.String sourceArn

The ARN of a verified email address in Amazon SES. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter:

• If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.

• If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.

The Region value of the SourceArn parameter must indicate a supported Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn and the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer Guide.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Class com.amazonaws.services.cognitoidentityprovider.model.EnableSoftwareTokenMFAException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.EventContextDataType extends java.lang.Object implements Serializable

Serialized Fields

city

java.lang.String city

The user's city.

country

java.lang.String country

The user's country.

deviceName

java.lang.String deviceName

The user's device name.

ipAddress

java.lang.String ipAddress

The source IP address of your user's device.

timezone

java.lang.String timezone

The user's time zone.

Class com.amazonaws.services.cognitoidentityprovider.model.EventFeedbackType extends java.lang.Object implements Serializable

Serialized Fields

feedbackDate

java.util.Date feedbackDate

The event feedback date.

feedbackValue

java.lang.String feedbackValue

The event feedback value.

Constraints:
Allowed Values: Valid, Invalid

provider

java.lang.String provider

The provider.

Class com.amazonaws.services.cognitoidentityprovider.model.EventRiskType extends java.lang.Object implements Serializable

Serialized Fields

compromisedCredentialsDetected

java.lang.Boolean compromisedCredentialsDetected

Indicates whether compromised credentials were detected during an authentication event.

riskDecision

java.lang.String riskDecision

The risk decision.

Constraints:
Allowed Values: NoRisk, AccountTakeover, Block

riskLevel

java.lang.String riskLevel

The risk level.

Constraints:
Allowed Values: Low, Medium, High

Class com.amazonaws.services.cognitoidentityprovider.model.ExpiredCodeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.ForbiddenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.ForgetDeviceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

deviceKey

java.lang.String deviceKey

The device key.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-f-]+

Class com.amazonaws.services.cognitoidentityprovider.model.ForgotPasswordRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

analyticsMetadata

AnalyticsMetadataType analyticsMetadata

The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.

clientId

java.lang.String clientId

The ID of the client associated with the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

clientMetadata

java.util.Map<java.lang.String,java.lang.String> clientMetadata

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

secretHash

java.lang.String secretHash

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Constraints:
Length: 1 - 128
Pattern: [\w+=/]+

userContextData

UserContextDataType userContextData

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

username

java.lang.String username

The user name of the user for whom you want to enter a code to reset a forgotten password.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Class com.amazonaws.services.cognitoidentityprovider.model.ForgotPasswordResult extends java.lang.Object implements Serializable

Serialized Fields

codeDeliveryDetails

CodeDeliveryDetailsType codeDeliveryDetails

The code delivery details returned by the server in response to the request to reset a password.

Class com.amazonaws.services.cognitoidentityprovider.model.GetCSVHeaderRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool that the users are to be imported into.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.GetCSVHeaderResult extends java.lang.Object implements Serializable

Serialized Fields

cSVHeader

java.util.List<java.lang.String> cSVHeader

The header information of the CSV file for the user import job.

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool that the users are to be imported into.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.GetDeviceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A valid access token that Amazon Cognito issued to the user whose device information you want to request.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

deviceKey

java.lang.String deviceKey

The device key.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-f-]+

Class com.amazonaws.services.cognitoidentityprovider.model.GetDeviceResult extends java.lang.Object implements Serializable

Serialized Fields

device

DeviceType device

The device.

Class com.amazonaws.services.cognitoidentityprovider.model.GetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

java.lang.String groupName

The name of the group.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.GetGroupResult extends java.lang.Object implements Serializable

Serialized Fields

group

GroupType group

The group object for the group.

Class com.amazonaws.services.cognitoidentityprovider.model.GetIdentityProviderByIdentifierRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

idpIdentifier

java.lang.String idpIdentifier

The IdP identifier.

Constraints:
Length: 1 - 40
Pattern: [\w\s+=.@-]+

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.GetIdentityProviderByIdentifierResult extends java.lang.Object implements Serializable

Serialized Fields

identityProvider

IdentityProviderType identityProvider

The IdP object.

Class com.amazonaws.services.cognitoidentityprovider.model.GetSigningCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.GetSigningCertificateResult extends java.lang.Object implements Serializable

Serialized Fields

certificate

java.lang.String certificate

The signing certificate.

Class com.amazonaws.services.cognitoidentityprovider.model.GetUICustomizationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientId

java.lang.String clientId

The client ID for the client app.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.GetUICustomizationResult extends java.lang.Object implements Serializable

Serialized Fields

uICustomization

UICustomizationType uICustomization

The UI customization information.

Class com.amazonaws.services.cognitoidentityprovider.model.GetUserAttributeVerificationCodeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A non-expired access token for the user whose attribute verification code you want to generate.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

attributeName

java.lang.String attributeName

The attribute name returned by the server response to get the user attribute verification code.

Constraints:
Length: 1 - 32
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

clientMetadata

java.util.Map<java.lang.String,java.lang.String> clientMetadata

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

Class com.amazonaws.services.cognitoidentityprovider.model.GetUserAttributeVerificationCodeResult extends java.lang.Object implements Serializable

Serialized Fields

codeDeliveryDetails

CodeDeliveryDetailsType codeDeliveryDetails

The code delivery details returned by the server in response to the request to get the user attribute verification code.

Class com.amazonaws.services.cognitoidentityprovider.model.GetUserPoolMfaConfigRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.GetUserPoolMfaConfigResult extends java.lang.Object implements Serializable

Serialized Fields

mfaConfiguration

java.lang.String mfaConfiguration

The multi-factor authentication (MFA) configuration. Valid values include:

• OFF MFA won't be used for any users.

• ON MFA is required for all users to sign in.

• OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

Constraints:
Allowed Values: OFF, ON, OPTIONAL

smsMfaConfiguration

SmsMfaConfigType smsMfaConfiguration

The SMS text message multi-factor authentication (MFA) configuration.

softwareTokenMfaConfiguration

SoftwareTokenMfaConfigType softwareTokenMfaConfiguration

The software token multi-factor authentication (MFA) configuration.

Class com.amazonaws.services.cognitoidentityprovider.model.GetUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A non-expired access token for the user whose information you want to query.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Class com.amazonaws.services.cognitoidentityprovider.model.GetUserResult extends java.lang.Object implements Serializable

Serialized Fields

mFAOptions

java.util.List<MFAOptionType> mFAOptions

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

preferredMfaSetting

java.lang.String preferredMfaSetting

The user's preferred MFA setting.

userAttributes

java.util.List<AttributeType> userAttributes

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

userMFASettingList

java.util.List<java.lang.String> userMFASettingList

The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

username

java.lang.String username

The user name of the user you want to retrieve from the get user request.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Class com.amazonaws.services.cognitoidentityprovider.model.GlobalSignOutRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A valid access token that Amazon Cognito issued to the user who you want to sign out.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Class com.amazonaws.services.cognitoidentityprovider.model.GlobalSignOutResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.GroupExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.GroupType extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The date the group was created.

description

java.lang.String description

A string containing the description of the group.

Constraints:
Length: - 2048

groupName

java.lang.String groupName

The name of the group.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

lastModifiedDate

java.util.Date lastModifiedDate

The date the group was last modified.

precedence

java.lang.Integer precedence

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher ornull Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

The default Precedence value is null.

Constraints:
Range: 0 -

roleArn

java.lang.String roleArn

The role Amazon Resource Name (ARN) for the group.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.HttpHeader extends java.lang.Object implements Serializable

Serialized Fields

headerName

java.lang.String headerName

The header name.

headerValue

java.lang.String headerValue

The header value.

Class com.amazonaws.services.cognitoidentityprovider.model.IdentityProviderType extends java.lang.Object implements Serializable

Serialized Fields

attributeMapping

java.util.Map<java.lang.String,java.lang.String> attributeMapping

A mapping of IdP attributes to standard and custom user pool attributes.

creationDate

java.util.Date creationDate

The date the IdP was created.

idpIdentifiers

java.util.List<java.lang.String> idpIdentifiers

A list of IdP identifiers.

lastModifiedDate

java.util.Date lastModifiedDate

The date the IdP was last modified.

providerDetails

java.util.Map<java.lang.String,java.lang.String> providerDetails

The IdP details. The following list describes the provider detail keys for each IdP type.

• For Google and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Facebook:

  • client_id

  • client_secret

  • authorize_scopes

  • api_version

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

    You can submit a private_key when you add or update an IdP. Describe operations don't return the private key.

  • authorize_scopes

• For OIDC providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

    • authorize_url

    • token_url

    • attributes_url

    • jwks_uri

  • Amazon Cognito sets the value of the following keys automatically. They are read-only.

    • attributes_url_add_attributes

• For SAML providers:

  • MetadataFile or MetadataURL

  • IDPSignout optional

providerName

java.lang.String providerName

The IdP name.

Constraints:
Length: 1 - 32
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

providerType

java.lang.String providerType

The IdP type.

Constraints:
Allowed Values: SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.InitiateAuthRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

analyticsMetadata

AnalyticsMetadataType analyticsMetadata

The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.

authFlow

java.lang.String authFlow

The authentication flow for this call to run. The API action will depend on this value. For example:

• REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.

• USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.

• USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns the next challenge or tokens.

Valid values include:

• USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.

• REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.

• CUSTOM_AUTH: Custom authentication flow.

• USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.

ADMIN_NO_SRP_AUTH isn't a valid value.

Constraints:
Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH, ADMIN_USER_PASSWORD_AUTH

authParameters

java.util.Map<java.lang.String,java.lang.String> authParameters

The authentication parameters. These are inputs corresponding to the AuthFlow that you're invoking. The required values depend on the value of AuthFlow:

• For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.

• For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.

• For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).

clientId

java.lang.String clientId

The app client ID.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

clientMetadata

java.util.Map<java.lang.String,java.lang.String> clientMetadata

A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:

• Pre signup

• Pre authentication

• User migration

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.

When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:

• Post authentication

• Custom message

• Pre token generation

• Create auth challenge

• Define auth challenge

• Verify auth challenge

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

userContextData

UserContextDataType userContextData

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

Class com.amazonaws.services.cognitoidentityprovider.model.InitiateAuthResult extends java.lang.Object implements Serializable

Serialized Fields

authenticationResult

AuthenticationResultType authenticationResult

The result of the authentication response. This result is only returned if the caller doesn't need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.

challengeName

java.lang.String challengeName

The name of the challenge that you're responding to with this call. This name is returned in the AdminInitiateAuth response if you must pass another challenge.

Valid values include the following:

All of the following challenges require USERNAME and SECRET_HASH (if applicable) in the parameters.

• SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.

• PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.

• CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.

• DEVICE_SRP_AUTH: If device tracking was activated on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.

• DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.

• NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login.

  Respond to this challenge with NEW_PASSWORD and any required attributes that Amazon Cognito returned in the requiredAttributes parameter. You can also set values for attributes that aren't required by your user pool and that your app client can write. For more information, see RespondToAuthChallenge.

  In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes.

• MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.

  To set up software token MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account, and then the user should call InitiateAuth again to restart sign-in.

Constraints:
Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED

challengeParameters

java.util.Map<java.lang.String,java.lang.String> challengeParameters

The challenge parameters. These are returned in the InitiateAuth response if you must pass another challenge. The responses in this parameter should be used to compute inputs to the next call (RespondToAuthChallenge).

All challenges require USERNAME and SECRET_HASH (if applicable).

session

java.lang.String session

The session that should pass both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.cognitoidentityprovider.model.InternalErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.InvalidEmailRoleAccessPolicyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.InvalidLambdaResponseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.InvalidOAuthFlowException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.InvalidPasswordException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.InvalidSmsRoleAccessPolicyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.InvalidSmsRoleTrustRelationshipException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.InvalidUserPoolConfigurationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.LambdaConfigType extends java.lang.Object implements Serializable

Serialized Fields

createAuthChallenge

java.lang.String createAuthChallenge

Creates an authentication challenge.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

customEmailSender

CustomEmailLambdaVersionConfigType customEmailSender

A custom email sender Lambda trigger.

customMessage

java.lang.String customMessage

A custom Message Lambda trigger.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

customSMSSender

CustomSMSLambdaVersionConfigType customSMSSender

A custom SMS sender Lambda trigger.

defineAuthChallenge

java.lang.String defineAuthChallenge

Defines the authentication challenge.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

kMSKeyID

java.lang.String kMSKeyID

The Amazon Resource Name (ARN) of an KMS key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to CustomEmailSender and CustomSMSSender.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

postAuthentication

java.lang.String postAuthentication

A post-authentication Lambda trigger.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

postConfirmation

java.lang.String postConfirmation

A post-confirmation Lambda trigger.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

preAuthentication

java.lang.String preAuthentication

A pre-authentication Lambda trigger.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

preSignUp

java.lang.String preSignUp

A pre-registration Lambda trigger.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

preTokenGeneration

java.lang.String preTokenGeneration

A Lambda trigger that is invoked before token generation.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

userMigration

java.lang.String userMigration

The user migration Lambda config type.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

verifyAuthChallengeResponse

java.lang.String verifyAuthChallengeResponse

Verifies the authentication challenge response.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Class com.amazonaws.services.cognitoidentityprovider.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.ListDevicesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

limit

java.lang.Integer limit

The limit of the device request.

Constraints:
Range: 0 - 60

paginationToken

java.lang.String paginationToken

The pagination token for the list request.

Constraints:
Length: 1 -
Pattern: [\S]+

Class com.amazonaws.services.cognitoidentityprovider.model.ListDevicesResult extends java.lang.Object implements Serializable

Serialized Fields

devices

java.util.List<DeviceType> devices

The devices returned in the list devices response.

paginationToken

java.lang.String paginationToken

The pagination token for the list device response.

Constraints:
Length: 1 -
Pattern: [\S]+

Class com.amazonaws.services.cognitoidentityprovider.model.ListGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

limit

java.lang.Integer limit

The limit of the request to list groups.

Constraints:
Range: 0 - 60

nextToken

java.lang.String nextToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Constraints:
Length: 1 -
Pattern: [\S]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.ListGroupsResult extends java.lang.Object implements Serializable

Serialized Fields

groups

java.util.List<GroupType> groups

The group objects for the groups.

nextToken

java.lang.String nextToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Constraints:
Length: 1 -
Pattern: [\S]+

Class com.amazonaws.services.cognitoidentityprovider.model.ListIdentityProvidersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of IdPs to return.

Constraints:
Range: 0 - 60

nextToken

java.lang.String nextToken

A pagination token.

Constraints:
Length: 1 -
Pattern: [\S]+

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.ListIdentityProvidersResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A pagination token.

Constraints:
Length: 1 -
Pattern: [\S]+

providers

java.util.List<ProviderDescription> providers

A list of IdP objects.

Class com.amazonaws.services.cognitoidentityprovider.model.ListResourceServersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of resource servers to return.

Constraints:
Range: 1 - 50

nextToken

java.lang.String nextToken

A pagination token.

Constraints:
Length: 1 -
Pattern: [\S]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.ListResourceServersResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A pagination token.

Constraints:
Length: 1 -
Pattern: [\S]+

resourceServers

java.util.List<ResourceServerType> resourceServers

The resource servers.

Class com.amazonaws.services.cognitoidentityprovider.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Class com.amazonaws.services.cognitoidentityprovider.model.ListTagsForResourceResult extends java.lang.Object implements Serializable

Serialized Fields

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags that are assigned to the user pool.

Class com.amazonaws.services.cognitoidentityprovider.model.ListUserImportJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of import jobs you want the request to return.

Constraints:
Range: 1 - 60

paginationToken

java.lang.String paginationToken

An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list.

Constraints:
Length: 1 -
Pattern: [\S]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool that the users are being imported into.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.ListUserImportJobsResult extends java.lang.Object implements Serializable

Serialized Fields

paginationToken

java.lang.String paginationToken

An identifier that can be used to return the next set of user import jobs in the list.

Constraints:
Length: 1 -
Pattern: [\S]+

userImportJobs

java.util.List<UserImportJobType> userImportJobs

The user import jobs.

Class com.amazonaws.services.cognitoidentityprovider.model.ListUserPoolClientsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results you want the request to return when listing the user pool clients.

Constraints:
Range: 1 - 60

nextToken

java.lang.String nextToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Constraints:
Length: 1 -
Pattern: [\S]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool where you want to list user pool clients.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.ListUserPoolClientsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Constraints:
Length: 1 -
Pattern: [\S]+

userPoolClients

java.util.List<UserPoolClientDescription> userPoolClients

The user pool clients in the response that lists user pool clients.

Class com.amazonaws.services.cognitoidentityprovider.model.ListUserPoolsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results you want the request to return when listing the user pools.

Constraints:
Range: 1 - 60

nextToken

java.lang.String nextToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Constraints:
Length: 1 -
Pattern: [\S]+

Class com.amazonaws.services.cognitoidentityprovider.model.ListUserPoolsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Constraints:
Length: 1 -
Pattern: [\S]+

userPools

java.util.List<UserPoolDescriptionType> userPools

The user pools from the response to list users.

Class com.amazonaws.services.cognitoidentityprovider.model.ListUsersInGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

java.lang.String groupName

The name of the group.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

limit

java.lang.Integer limit

The limit of the request to list users.

Constraints:
Range: 0 - 60

nextToken

java.lang.String nextToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Constraints:
Length: 1 -
Pattern: [\S]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.ListUsersInGroupResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

An identifier that you can use in a later request to return the next set of items in the list.

Constraints:
Length: 1 -
Pattern: [\S]+

users

java.util.List<UserType> users

The users returned in the request to list users.

Class com.amazonaws.services.cognitoidentityprovider.model.ListUsersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributesToGet

java.util.List<java.lang.String> attributesToGet

An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.

filter

java.lang.String filter

A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash (\) character. For example, "family_name = \"Reddy\"".

• AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.

• Filter-Type: For an exact match, use =, for example, " given_name = \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"".

• AttributeValue: The attribute value that must be matched for each user.

If the filter string is empty, ListUsers returns all users in the user pool.

You can only search for the following standard attributes:

• username (case-sensitive)

• email

• phone_number

• name

• given_name

• family_name

• preferred_username

• cognito:user_status (called Status in the Console) (case-insensitive)

• status (called Enabled in the Console) (case-sensitive)

• sub

Custom attributes aren't searchable.

You can also list users with a client-side filter. The server-side filter matches no more than one attribute. For an advanced search, use a client-side filter with the --query parameter of the list-users action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result.

For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface User Guide.

For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.

Constraints:
Length: - 256

limit

java.lang.Integer limit

Maximum number of users to be returned.

Constraints:
Range: 0 - 60

paginationToken

java.lang.String paginationToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Constraints:
Length: 1 -
Pattern: [\S]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool on which the search should be performed.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.ListUsersResult extends java.lang.Object implements Serializable

Serialized Fields

paginationToken

java.lang.String paginationToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Constraints:
Length: 1 -
Pattern: [\S]+

users

java.util.List<UserType> users

The users returned in the request to list users.

Class com.amazonaws.services.cognitoidentityprovider.model.MessageTemplateType extends java.lang.Object implements Serializable

Serialized Fields

emailMessage

java.lang.String emailMessage

The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.

Constraints:
Length: 6 - 20000
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{ N}\p{P}\s*]*

emailSubject

java.lang.String emailSubject

The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.

Constraints:
Length: 1 - 140
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+

sMSMessage

java.lang.String sMSMessage

The message template for SMS messages.

Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*

Class com.amazonaws.services.cognitoidentityprovider.model.MFAMethodNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.MFAOptionType extends java.lang.Object implements Serializable

Serialized Fields

attributeName

java.lang.String attributeName

The attribute name of the MFA option type. The only valid value is phone_number.

Constraints:
Length: 1 - 32
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

deliveryMedium

java.lang.String deliveryMedium

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

Constraints:
Allowed Values: SMS, EMAIL

Class com.amazonaws.services.cognitoidentityprovider.model.NewDeviceMetadataType extends java.lang.Object implements Serializable

Serialized Fields

deviceGroupKey

java.lang.String deviceGroupKey

The device group key.

deviceKey

java.lang.String deviceKey

The device key.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-f-]+

Class com.amazonaws.services.cognitoidentityprovider.model.NotAuthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.NotifyConfigurationType extends java.lang.Object implements Serializable

Serialized Fields

blockEmail

NotifyEmailType blockEmail

Email template used when a detected risk event is blocked.

from

java.lang.String from

The email address that is sending the email. The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.

mfaEmail

NotifyEmailType mfaEmail

The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk.

noActionEmail

NotifyEmailType noActionEmail

The email template used when a detected risk event is allowed.

replyTo

java.lang.String replyTo

The destination to which the receiver of an email should reply to.

sourceArn

java.lang.String sourceArn

The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. This identity permits Amazon Cognito to send for the email address specified in the From parameter.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Class com.amazonaws.services.cognitoidentityprovider.model.NotifyEmailType extends java.lang.Object implements Serializable

Serialized Fields

htmlBody

java.lang.String htmlBody

The email HTML body.

Constraints:
Length: 6 - 20000
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]+

subject

java.lang.String subject

The email subject.

Constraints:
Length: 1 - 140
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+

textBody

java.lang.String textBody

The email text body.

Constraints:
Length: 6 - 20000
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]+

Class com.amazonaws.services.cognitoidentityprovider.model.NumberAttributeConstraintsType extends java.lang.Object implements Serializable

Serialized Fields

maxValue

java.lang.String maxValue

The maximum value of an attribute that is of the number data type.

minValue

java.lang.String minValue

The minimum value of an attribute that is of the number data type.

Class com.amazonaws.services.cognitoidentityprovider.model.PasswordPolicyType extends java.lang.Object implements Serializable

Serialized Fields

minimumLength

java.lang.Integer minimumLength

The minimum length of the password in the policy that you have set. This value can't be less than 6.

Constraints:
Range: 6 - 99

requireLowercase

java.lang.Boolean requireLowercase

In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.

requireNumbers

java.lang.Boolean requireNumbers

In the password policy that you have set, refers to whether you have required users to use at least one number in their password.

requireSymbols

java.lang.Boolean requireSymbols

In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.

requireUppercase

java.lang.Boolean requireUppercase

In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.

temporaryPasswordValidityDays

java.lang.Integer temporaryPasswordValidityDays

The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password.

When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.

Constraints:
Range: 0 - 365

Class com.amazonaws.services.cognitoidentityprovider.model.PasswordResetRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.PreconditionNotMetException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.ProviderDescription extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The date the provider was added to the user pool.

lastModifiedDate

java.util.Date lastModifiedDate

The date the provider was last modified.

providerName

java.lang.String providerName

The IdP name.

Constraints:
Length: 1 - 32
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

providerType

java.lang.String providerType

The IdP type.

Constraints:
Allowed Values: SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC

Class com.amazonaws.services.cognitoidentityprovider.model.ProviderUserIdentifierType extends java.lang.Object implements Serializable

Serialized Fields

providerAttributeName

java.lang.String providerAttributeName

The name of the provider attribute to link to, such as NameID.

providerAttributeValue

java.lang.String providerAttributeValue

The value of the provider attribute to link to, such as xxxxx_account.

providerName

java.lang.String providerName

The name of the provider, such as Facebook, Google, or Login with Amazon.

Constraints:
Length: 1 - 32
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Class com.amazonaws.services.cognitoidentityprovider.model.RecoveryOptionType extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The recovery method for a user.

Constraints:
Allowed Values: verified_email, verified_phone_number, admin_only

priority

java.lang.Integer priority

A positive integer specifying priority of a method with 1 being the highest priority.

Constraints:
Range: 1 - 2

Class com.amazonaws.services.cognitoidentityprovider.model.ResendConfirmationCodeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

analyticsMetadata

AnalyticsMetadataType analyticsMetadata

The Amazon Pinpoint analytics metadata that contributes to your metrics for ResendConfirmationCode calls.

clientId

java.lang.String clientId

The ID of the client associated with the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

clientMetadata

java.util.Map<java.lang.String,java.lang.String> clientMetadata

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

secretHash

java.lang.String secretHash

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Constraints:
Length: 1 - 128
Pattern: [\w+=/]+

userContextData

UserContextDataType userContextData

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

username

java.lang.String username

The username attribute of the user to whom you want to resend a confirmation code.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Class com.amazonaws.services.cognitoidentityprovider.model.ResendConfirmationCodeResult extends java.lang.Object implements Serializable

Serialized Fields

codeDeliveryDetails

CodeDeliveryDetailsType codeDeliveryDetails

The code delivery details returned by the server in response to the request to resend the confirmation code.

Class com.amazonaws.services.cognitoidentityprovider.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.ResourceServerScopeType extends java.lang.Object implements Serializable

Serialized Fields

scopeDescription

java.lang.String scopeDescription

A description of the scope.

Constraints:
Length: 1 - 256

scopeName

java.lang.String scopeName

The name of the scope.

Constraints:
Length: 1 - 256
Pattern: [\x21\x23-\x2E\x30-\x5B\x5D-\x7E]+

Class com.amazonaws.services.cognitoidentityprovider.model.ResourceServerType extends java.lang.Object implements Serializable

Serialized Fields

identifier

java.lang.String identifier

The identifier for the resource server.

Constraints:
Length: 1 - 256
Pattern: [\x21\x23-\x5B\x5D-\x7E]+

name

java.lang.String name

The name of the resource server.

Constraints:
Length: 1 - 256
Pattern: [\w\s+=,.@-]+

scopes

java.util.List<ResourceServerScopeType> scopes

A list of scopes that are defined for the resource server.

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool that hosts the resource server.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.RespondToAuthChallengeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

analyticsMetadata

AnalyticsMetadataType analyticsMetadata

The Amazon Pinpoint analytics metadata that contributes to your metrics for RespondToAuthChallenge calls.

challengeName

java.lang.String challengeName

The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH isn't a valid value.

Constraints:
Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED

challengeResponses

java.util.Map<java.lang.String,java.lang.String> challengeResponses

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all of the inputs that follow (including SOFTWARE_TOKEN_MFA).

• SMS_MFA: SMS_MFA_CODE, USERNAME.

• PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  PASSWORD_VERIFIER requires DEVICE_KEY when you sign in with a remembered device.

• NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the InitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.

  In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes.

• SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

• DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH ).

• DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires, plus DEVICE_KEY.

• MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.

clientId

java.lang.String clientId

The app client ID.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

clientMetadata

java.util.Map<java.lang.String,java.lang.String> clientMetadata

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

session

java.lang.String session

The session that should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Constraints:
Length: 20 - 2048

userContextData

UserContextDataType userContextData

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

Class com.amazonaws.services.cognitoidentityprovider.model.RespondToAuthChallengeResult extends java.lang.Object implements Serializable

Serialized Fields

authenticationResult

AuthenticationResultType authenticationResult

The result returned by the server in response to the request to respond to the authentication challenge.

challengeName

java.lang.String challengeName

The challenge name. For more information, see InitiateAuth.

Constraints:
Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED

challengeParameters

java.util.Map<java.lang.String,java.lang.String> challengeParameters

The challenge parameters. For more information, see InitiateAuth.

session

java.lang.String session

The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.cognitoidentityprovider.model.RevokeTokenRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientId

java.lang.String clientId

The client ID for the token that you want to revoke.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

clientSecret

java.lang.String clientSecret

The secret for the client ID. This is required only if the client ID has a secret.

Constraints:
Length: 1 - 64
Pattern: [\w+]+

token

java.lang.String token

The refresh token that you want to revoke.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Class com.amazonaws.services.cognitoidentityprovider.model.RevokeTokenResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.RiskConfigurationType extends java.lang.Object implements Serializable

Serialized Fields

accountTakeoverRiskConfiguration

AccountTakeoverRiskConfigurationType accountTakeoverRiskConfiguration

The account takeover risk configuration object, including the NotifyConfiguration object and Actions to take if there is an account takeover.

clientId

java.lang.String clientId

The app client ID.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

compromisedCredentialsRiskConfiguration

CompromisedCredentialsRiskConfigurationType compromisedCredentialsRiskConfiguration

The compromised credentials risk configuration object, including the EventFilter and the EventAction.

lastModifiedDate

java.util.Date lastModifiedDate

The last modified date.

riskExceptionConfiguration

RiskExceptionConfigurationType riskExceptionConfiguration

The configuration to override the risk decision.

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.RiskExceptionConfigurationType extends java.lang.Object implements Serializable

Serialized Fields

blockedIPRangeList

java.util.List<java.lang.String> blockedIPRangeList

Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation, a compact representation of an IP address and its routing prefix.

skippedIPRangeList

java.util.List<java.lang.String> skippedIPRangeList

Risk detection isn't performed on the IP addresses in this range list. The IP range is in CIDR notation.

Class com.amazonaws.services.cognitoidentityprovider.model.SchemaAttributeType extends java.lang.Object implements Serializable

Serialized Fields

attributeDataType

java.lang.String attributeDataType

The attribute data type.

Constraints:
Allowed Values: String, Number, DateTime, Boolean

developerOnlyAttribute

java.lang.Boolean developerOnlyAttribute

You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute.

Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won't be able to modify this attribute using their access token. For example, DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.

mutable

java.lang.Boolean mutable

Specifies whether the value of the attribute can be changed.

For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.

name

java.lang.String name

A schema attribute of the name type.

Constraints:
Length: 1 - 20
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

numberAttributeConstraints

NumberAttributeConstraintsType numberAttributeConstraints

Specifies the constraints for an attribute of the number type.

required

java.lang.Boolean required

Specifies whether a user pool attribute is required. If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.

stringAttributeConstraints

StringAttributeConstraintsType stringAttributeConstraints

Specifies the constraints for an attribute of the string type.

Class com.amazonaws.services.cognitoidentityprovider.model.ScopeDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.SetRiskConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountTakeoverRiskConfiguration

AccountTakeoverRiskConfigurationType accountTakeoverRiskConfiguration

The account takeover risk configuration.

clientId

java.lang.String clientId

The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.

Otherwise, ClientId is mapped to the client. When the client ID isn't null, the user pool configuration is overridden and the risk configuration for the client is used instead.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

compromisedCredentialsRiskConfiguration

CompromisedCredentialsRiskConfigurationType compromisedCredentialsRiskConfiguration

The compromised credentials risk configuration.

riskExceptionConfiguration

RiskExceptionConfigurationType riskExceptionConfiguration

The configuration to override the risk decision.

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.SetRiskConfigurationResult extends java.lang.Object implements Serializable

Serialized Fields

riskConfiguration

RiskConfigurationType riskConfiguration

The risk configuration.

Class com.amazonaws.services.cognitoidentityprovider.model.SetUICustomizationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientId

java.lang.String clientId

The client ID for the client app.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

cSS

java.lang.String cSS

The CSS values in the UI customization.

imageFile

java.nio.ByteBuffer imageFile

The uploaded logo image for the UI customization.

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.SetUICustomizationResult extends java.lang.Object implements Serializable

Serialized Fields

uICustomization

UICustomizationType uICustomization

The UI customization information.

Class com.amazonaws.services.cognitoidentityprovider.model.SetUserMFAPreferenceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

sMSMfaSettings

SMSMfaSettingsType sMSMfaSettings

The SMS text message multi-factor authentication (MFA) settings.

softwareTokenMfaSettings

SoftwareTokenMfaSettingsType softwareTokenMfaSettings

The time-based one-time password (TOTP) software token MFA settings.

Class com.amazonaws.services.cognitoidentityprovider.model.SetUserMFAPreferenceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.SetUserPoolMfaConfigRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

mfaConfiguration

java.lang.String mfaConfiguration

The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:

• OFF MFA won't be used for any users.

• ON MFA is required for all users to sign in.

• OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

Constraints:
Allowed Values: OFF, ON, OPTIONAL

smsMfaConfiguration

SmsMfaConfigType smsMfaConfiguration

The SMS text message MFA configuration.

softwareTokenMfaConfiguration

SoftwareTokenMfaConfigType softwareTokenMfaConfiguration

The software token MFA configuration.

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.SetUserPoolMfaConfigResult extends java.lang.Object implements Serializable

Serialized Fields

mfaConfiguration

java.lang.String mfaConfiguration

The MFA configuration. Valid values include:

• OFF MFA won't be used for any users.

• ON MFA is required for all users to sign in.

• OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.

Constraints:
Allowed Values: OFF, ON, OPTIONAL

smsMfaConfiguration

SmsMfaConfigType smsMfaConfiguration

The SMS text message MFA configuration.

softwareTokenMfaConfiguration

SoftwareTokenMfaConfigType softwareTokenMfaConfiguration

The software token MFA configuration.

Class com.amazonaws.services.cognitoidentityprovider.model.SetUserSettingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

mFAOptions

java.util.List<MFAOptionType> mFAOptions

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Class com.amazonaws.services.cognitoidentityprovider.model.SetUserSettingsResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.SignUpRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

analyticsMetadata

AnalyticsMetadataType analyticsMetadata

The Amazon Pinpoint analytics metadata that contributes to your metrics for SignUp calls.

clientId

java.lang.String clientId

The ID of the client associated with the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

clientMetadata

java.util.Map<java.lang.String,java.lang.String> clientMetadata

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

password

java.lang.String password

The password of the user you want to register.

Constraints:
Length: - 256
Pattern: [\S]+

secretHash

java.lang.String secretHash

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Constraints:
Length: 1 - 128
Pattern: [\w+=/]+

userAttributes

java.util.List<AttributeType> userAttributes

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

userContextData

UserContextDataType userContextData

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

username

java.lang.String username

The user name of the user you want to register.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

validationData

java.util.List<AttributeType> validationData

The validation data in the request to register a user.

Class com.amazonaws.services.cognitoidentityprovider.model.SignUpResult extends java.lang.Object implements Serializable

Serialized Fields

codeDeliveryDetails

CodeDeliveryDetailsType codeDeliveryDetails

The code delivery details returned by the server response to the user registration request.

userConfirmed

java.lang.Boolean userConfirmed

A response from the server indicating that a user registration has been confirmed.

userSub

java.lang.String userSub

The UUID of the authenticated user. This isn't the same as username.

Class com.amazonaws.services.cognitoidentityprovider.model.SmsConfigurationType extends java.lang.Object implements Serializable

Serialized Fields

externalId

java.lang.String externalId

The external ID provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the ExternalId.

For more information about the ExternalId of a role, see How to use an external ID when granting access to your Amazon Web Services resources to a third party

snsCallerArn

java.lang.String snsCallerArn

The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

snsRegion

java.lang.String snsRegion

The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported Legacy Amazon SNS alternate Region.

Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.

Constraints:
Length: 5 - 32

Class com.amazonaws.services.cognitoidentityprovider.model.SmsMfaConfigType extends java.lang.Object implements Serializable

Serialized Fields

smsAuthenticationMessage

java.lang.String smsAuthenticationMessage

The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####}’ placeholder, which is replaced with the code. If the message isn't included, and default message will be used.

Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*

smsConfiguration

SmsConfigurationType smsConfiguration

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.

Class com.amazonaws.services.cognitoidentityprovider.model.SMSMfaSettingsType extends java.lang.Object implements Serializable

Serialized Fields

enabled

java.lang.Boolean enabled

Specifies whether SMS text message MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.

preferredMfa

java.lang.Boolean preferredMfa

Specifies whether SMS is the preferred MFA method.

Class com.amazonaws.services.cognitoidentityprovider.model.SoftwareTokenMfaConfigType extends java.lang.Object implements Serializable

Serialized Fields

enabled

java.lang.Boolean enabled

Specifies whether software token MFA is activated.

Class com.amazonaws.services.cognitoidentityprovider.model.SoftwareTokenMFANotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.SoftwareTokenMfaSettingsType extends java.lang.Object implements Serializable

Serialized Fields

enabled

java.lang.Boolean enabled

Specifies whether software token MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.

preferredMfa

java.lang.Boolean preferredMfa

Specifies whether software token MFA is the preferred MFA method.

Class com.amazonaws.services.cognitoidentityprovider.model.StartUserImportJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The job ID for the user import job.

Constraints:
Length: 1 - 55
Pattern: import-[0-9a-zA-Z-]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool that the users are being imported into.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.StartUserImportJobResult extends java.lang.Object implements Serializable

Serialized Fields

userImportJob

UserImportJobType userImportJob

The job object that represents the user import job.

Class com.amazonaws.services.cognitoidentityprovider.model.StopUserImportJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The job ID for the user import job.

Constraints:
Length: 1 - 55
Pattern: import-[0-9a-zA-Z-]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool that the users are being imported into.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.StopUserImportJobResult extends java.lang.Object implements Serializable

Serialized Fields

userImportJob

UserImportJobType userImportJob

The job object that represents the user import job.

Class com.amazonaws.services.cognitoidentityprovider.model.StringAttributeConstraintsType extends java.lang.Object implements Serializable

Serialized Fields

maxLength

java.lang.String maxLength

The maximum length.

minLength

java.lang.String minLength

The minimum length.

Class com.amazonaws.services.cognitoidentityprovider.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the user pool to assign the tags to.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags to assign to the user pool.

Class com.amazonaws.services.cognitoidentityprovider.model.TagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.TokenValidityUnitsType extends java.lang.Object implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A time unit of seconds, minutes, hours, or days for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours.

Constraints:
Allowed Values: seconds, minutes, hours, days

idToken

java.lang.String idToken

A time unit of seconds, minutes, hours, or days for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours.

Constraints:
Allowed Values: seconds, minutes, hours, days

refreshToken

java.lang.String refreshToken

A time unit of seconds, minutes, hours, or days for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days.

Constraints:
Allowed Values: seconds, minutes, hours, days

Class com.amazonaws.services.cognitoidentityprovider.model.TooManyFailedAttemptsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.TooManyRequestsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.UICustomizationType extends java.lang.Object implements Serializable

Serialized Fields

clientId

java.lang.String clientId

The client ID for the client app.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

creationDate

java.util.Date creationDate

The creation date for the UI customization.

cSS

java.lang.String cSS

The CSS values in the UI customization.

cSSVersion

java.lang.String cSSVersion

The CSS version number.

imageUrl

java.lang.String imageUrl

The logo image for the UI customization.

lastModifiedDate

java.util.Date lastModifiedDate

The last-modified date for the UI customization.

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.UnauthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.UnexpectedLambdaException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.UnsupportedIdentityProviderException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.UnsupportedOperationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.UnsupportedTokenTypeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.UnsupportedUserStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

tagKeys

java.util.List<java.lang.String> tagKeys

The keys of the tags to remove from the user pool.

Class com.amazonaws.services.cognitoidentityprovider.model.UntagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateAuthEventFeedbackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

eventId

java.lang.String eventId

The event ID.

Constraints:
Length: 1 - 50
Pattern: [\w+-]+

feedbackToken

java.lang.String feedbackToken

The feedback token.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

feedbackValue

java.lang.String feedbackValue

The authentication event feedback value.

Constraints:
Allowed Values: Valid, Invalid

username

java.lang.String username

The user pool username.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateAuthEventFeedbackResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateDeviceStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A valid access token that Amazon Cognito issued to the user whose device status you want to update.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

deviceKey

java.lang.String deviceKey

The device key.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-f-]+

deviceRememberedStatus

java.lang.String deviceRememberedStatus

The status of whether a device is remembered.

Constraints:
Allowed Values: remembered, not_remembered

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateDeviceStatusResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

A string containing the new description of the group.

Constraints:
Length: - 2048

groupName

java.lang.String groupName

The name of the group.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

precedence

java.lang.Integer precedence

The new precedence value for the group. For more information about this parameter, see CreateGroup.

Constraints:
Range: 0 -

roleArn

java.lang.String roleArn

The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateGroupResult extends java.lang.Object implements Serializable

Serialized Fields

group

GroupType group

The group object for the group.

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateIdentityProviderRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeMapping

java.util.Map<java.lang.String,java.lang.String> attributeMapping

The IdP attribute mapping to be changed.

idpIdentifiers

java.util.List<java.lang.String> idpIdentifiers

A list of IdP identifiers.

providerDetails

java.util.Map<java.lang.String,java.lang.String> providerDetails

The IdP details to be updated, such as MetadataURL and MetadataFile.

providerName

java.lang.String providerName

The IdP name.

Constraints:
Length: 1 - 32
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userPoolId

java.lang.String userPoolId

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateIdentityProviderResult extends java.lang.Object implements Serializable

Serialized Fields

identityProvider

IdentityProviderType identityProvider

The IdP object.

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateResourceServerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identifier

java.lang.String identifier

The identifier for the resource server.

Constraints:
Length: 1 - 256
Pattern: [\x21\x23-\x5B\x5D-\x7E]+

name

java.lang.String name

The name of the resource server.

Constraints:
Length: 1 - 256
Pattern: [\w\s+=,.@-]+

scopes

java.util.List<ResourceServerScopeType> scopes

The scope values to be set for the resource server.

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateResourceServerResult extends java.lang.Object implements Serializable

Serialized Fields

resourceServer

ResourceServerType resourceServer

The resource server.

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateUserAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

clientMetadata

java.util.Map<java.lang.String,java.lang.String> clientMetadata

A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

userAttributes

java.util.List<AttributeType> userAttributes

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateUserAttributesResult extends java.lang.Object implements Serializable

Serialized Fields

codeDeliveryDetailsList

java.util.List<CodeDeliveryDetailsType> codeDeliveryDetailsList

The code delivery details list from the server for the request to update user attributes.

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessTokenValidity

java.lang.Integer accessTokenValidity

The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours , your user can authorize access with their access token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

Constraints:
Range: 1 - 86400

allowedOAuthFlows

java.util.List<java.lang.String> allowedOAuthFlows

The allowed OAuth flows.

code

Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.

implicit

Issue the access token (and, optionally, ID token, based on scopes) directly to your user.

client_credentials

Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.

allowedOAuthFlowsUserPoolClient

java.lang.Boolean allowedOAuthFlowsUserPoolClient

Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.

allowedOAuthScopes

java.util.List<java.lang.String> allowedOAuthScopes

The allowed OAuth scopes. Possible values provided by OAuth are phone, email, openid, and profile. Possible values provided by Amazon Web Services are aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

analyticsConfiguration

AnalyticsConfigurationType analyticsConfiguration

The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.

In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

authSessionValidity

java.lang.Integer authSessionValidity

Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

Constraints:
Range: 3 - 15

callbackURLs

java.util.List<java.lang.String> callbackURLs

A list of allowed redirect (callback) URLs for the IdPs.

A redirect URI must:

• Be an absolute URI.

• Be registered with the authorization server.

• Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

clientId

java.lang.String clientId

The ID of the client associated with the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

clientName

java.lang.String clientName

The client name from the update user pool client request.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

defaultRedirectURI

java.lang.String defaultRedirectURI

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

• Be an absolute URI.

• Be registered with the authorization server.

• Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Constraints:
Length: 1 - 1024
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

enablePropagateAdditionalUserContextData

java.lang.Boolean enablePropagateAdditionalUserContextData

Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.

enableTokenRevocation

java.lang.Boolean enableTokenRevocation

Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.

explicitAuthFlows

java.util.List<java.lang.String> explicitAuthFlows

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are no longer supported in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with values with the ALLOW_ prefix.

Valid values include:

• ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.

• ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

• ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

• ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.

• ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

idTokenValidity

java.lang.Integer idTokenValidity

The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

Constraints:
Range: 1 - 86400

logoutURLs

java.util.List<java.lang.String> logoutURLs

A list of allowed logout URLs for the IdPs.

preventUserExistenceErrors

java.lang.String preventUserExistenceErrors

Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.

Valid values include:

• ENABLED - This prevents user existence-related errors.

• LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.

Constraints:
Allowed Values: LEGACY, ENABLED

readAttributes

java.util.List<java.lang.String> readAttributes

The read-only attributes of the user pool.

refreshTokenValidity

java.lang.Integer refreshTokenValidity

The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days.

The default time unit for RefreshTokenValidity in an API request is days. You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.

Constraints:
Range: 0 - 315360000

supportedIdentityProviders

java.util.List<java.lang.String> supportedIdentityProviders

A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google, SignInWithApple, LoginWithAmazon, and the names of your own SAML and OIDC providers.

tokenValidityUnits

TokenValidityUnitsType tokenValidityUnits

The units in which the validity times are represented. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool where you want to update the user pool client.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

writeAttributes

java.util.List<java.lang.String> writeAttributes

The writeable attributes of the user pool.

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateUserPoolClientResult extends java.lang.Object implements Serializable

Serialized Fields

userPoolClient

UserPoolClientType userPoolClient

The user pool client value from the response from the server when you request to update the user pool client.

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateUserPoolDomainRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customDomainConfig

CustomDomainConfigType customDomainConfig

The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.

domain

java.lang.String domain

The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be auth.example.com.

This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.

Constraints:
Length: 1 - 63
Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

userPoolId

java.lang.String userPoolId

The ID of the user pool that is associated with the custom domain whose certificate you're updating.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateUserPoolDomainResult extends java.lang.Object implements Serializable

Serialized Fields

cloudFrontDomain

java.lang.String cloudFrontDomain

The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user pool.

Constraints:
Length: 1 - 63
Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateUserPoolRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountRecoverySetting

AccountRecoverySettingType accountRecoverySetting

The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

adminCreateUserConfig

AdminCreateUserConfigType adminCreateUserConfig

The configuration for AdminCreateUser requests.

autoVerifiedAttributes

java.util.List<java.lang.String> autoVerifiedAttributes

The attributes that are automatically verified when Amazon Cognito requests to update user pools.

deviceConfiguration

DeviceConfigurationType deviceConfiguration

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

emailConfiguration

EmailConfigurationType emailConfiguration

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.

emailVerificationMessage

java.lang.String emailVerificationMessage

This parameter is no longer used. See VerificationMessageTemplateType.

Constraints:
Length: 6 - 20000
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{ N}\p{P}\s*]*

emailVerificationSubject

java.lang.String emailVerificationSubject

This parameter is no longer used. See VerificationMessageTemplateType.

Constraints:
Length: 1 - 140
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+

lambdaConfig

LambdaConfigType lambdaConfig

The Lambda configuration information from the request to update the user pool.

mfaConfiguration

java.lang.String mfaConfiguration

Possible values include:

• OFF - MFA tokens aren't required and can't be specified during user registration.

• ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.

• OPTIONAL - Users have the option when registering to create an MFA token.

Constraints:
Allowed Values: OFF, ON, OPTIONAL

policies

UserPoolPolicyType policies

A container with the policies you want to update in a user pool.

smsAuthenticationMessage

java.lang.String smsAuthenticationMessage

The contents of the SMS authentication message.

Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*

smsConfiguration

SmsConfigurationType smsConfiguration

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

smsVerificationMessage

java.lang.String smsVerificationMessage

This parameter is no longer used. See VerificationMessageTemplateType.

Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*

userAttributeUpdateSettings

UserAttributeUpdateSettingsType userAttributeUpdateSettings

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

userPoolAddOns

UserPoolAddOnsType userPoolAddOns

Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool you want to update.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

userPoolTags

java.util.Map<java.lang.String,java.lang.String> userPoolTags

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

verificationMessageTemplate

VerificationMessageTemplateType verificationMessageTemplate

The template for verification messages.

Class com.amazonaws.services.cognitoidentityprovider.model.UpdateUserPoolResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.cognitoidentityprovider.model.UserAttributeUpdateSettingsType extends java.lang.Object implements Serializable

Serialized Fields

attributesRequireVerificationBeforeUpdate

java.util.List<java.lang.String> attributesRequireVerificationBeforeUpdate

Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.

You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.

When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.

Class com.amazonaws.services.cognitoidentityprovider.model.UserContextDataType extends java.lang.Object implements Serializable

Serialized Fields

encodedData

java.lang.String encodedData

Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

ipAddress

java.lang.String ipAddress

The source IP address of your user's device.

Class com.amazonaws.services.cognitoidentityprovider.model.UserImportInProgressException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.UserImportJobType extends java.lang.Object implements Serializable

Serialized Fields

cloudWatchLogsRoleArn

java.lang.String cloudWatchLogsRoleArn

The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

completionDate

java.util.Date completionDate

The date when the user import job was completed.

completionMessage

java.lang.String completionMessage

The message returned when the user import job is completed.

Constraints:
Length: 1 - 128
Pattern: [\w]+

creationDate

java.util.Date creationDate

The date the user import job was created.

failedUsers

java.lang.Long failedUsers

The number of users that couldn't be imported.

importedUsers

java.lang.Long importedUsers

The number of users that were successfully imported.

jobId

java.lang.String jobId

The job ID for the user import job.

Constraints:
Length: 1 - 55
Pattern: import-[0-9a-zA-Z-]+

jobName

java.lang.String jobName

The job name for the user import job.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

preSignedUrl

java.lang.String preSignedUrl

The pre-signed URL to be used to upload the .csv file.

Constraints:
Length: 0 - 2048

skippedUsers

java.lang.Long skippedUsers

The number of users that were skipped.

startDate

java.util.Date startDate

The date when the user import job was started.

status

java.lang.String status

The status of the user import job. One of the following:

• Created - The job was created but not started.

• Pending - A transition state. You have started the job, but it has not begun importing users yet.

• InProgress - The job has started, and users are being imported.

• Stopping - You have stopped the job, but the job has not stopped importing users yet.

• Stopped - You have stopped the job, and the job has stopped importing users.

• Succeeded - The job has completed successfully.

• Failed - The job has stopped due to an error.

• Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job can't be started.

Constraints:
Allowed Values: Created, Pending, InProgress, Stopping, Expired, Stopped, Failed, Succeeded

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool that the users are being imported into.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.UserLambdaValidationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.UsernameConfigurationType extends java.lang.Object implements Serializable

Serialized Fields

caseSensitive

java.lang.Boolean caseSensitive

Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.

Valid values include:

True

Enables case sensitivity for all username input. When this option is set to True, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.

False

Enables case insensitivity for all username input. For example, when this option is set to False, users can sign in using either "username" or "Username". This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.

Class com.amazonaws.services.cognitoidentityprovider.model.UsernameExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.UserNotConfirmedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.UserNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.UserPoolAddOnNotEnabledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.UserPoolAddOnsType extends java.lang.Object implements Serializable

Serialized Fields

advancedSecurityMode

java.lang.String advancedSecurityMode

The advanced security mode.

Constraints:
Allowed Values: OFF, AUDIT, ENFORCED

Class com.amazonaws.services.cognitoidentityprovider.model.UserPoolClientDescription extends java.lang.Object implements Serializable

Serialized Fields

clientId

java.lang.String clientId

The ID of the client associated with the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

clientName

java.lang.String clientName

The client name from the user pool client description.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool where you want to describe the user pool client.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Class com.amazonaws.services.cognitoidentityprovider.model.UserPoolClientType extends java.lang.Object implements Serializable

Serialized Fields

accessTokenValidity

java.lang.Integer accessTokenValidity

The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours , your user can authorize access with their access token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

Constraints:
Range: 1 - 86400

allowedOAuthFlows

java.util.List<java.lang.String> allowedOAuthFlows

The allowed OAuth flows.

code

Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.

implicit

Issue the access token (and, optionally, ID token, based on scopes) directly to your user.

client_credentials

Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.

allowedOAuthFlowsUserPoolClient

java.lang.Boolean allowedOAuthFlowsUserPoolClient

Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.

allowedOAuthScopes

java.util.List<java.lang.String> allowedOAuthScopes

The OAuth scopes that your app client supports. Possible values that OAuth provides are phone, email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.

analyticsConfiguration

AnalyticsConfigurationType analyticsConfiguration

The Amazon Pinpoint analytics configuration for the user pool client.

Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.

authSessionValidity

java.lang.Integer authSessionValidity

Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

Constraints:
Range: 3 - 15

callbackURLs

java.util.List<java.lang.String> callbackURLs

A list of allowed redirect (callback) URLs for the IdPs.

A redirect URI must:

• Be an absolute URI.

• Be registered with the authorization server.

• Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

clientId

java.lang.String clientId

The ID of the client associated with the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

clientName

java.lang.String clientName

The client name from the user pool request of the client type.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

clientSecret

java.lang.String clientSecret

The client secret from the user pool request of the client type.

Constraints:
Length: 1 - 64
Pattern: [\w+]+

creationDate

java.util.Date creationDate

The date the user pool client was created.

defaultRedirectURI

java.lang.String defaultRedirectURI

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

• Be an absolute URI.

• Be registered with the authorization server.

• Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Constraints:
Length: 1 - 1024
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

enablePropagateAdditionalUserContextData

java.lang.Boolean enablePropagateAdditionalUserContextData

When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.

When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge.

You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.

enableTokenRevocation

java.lang.Boolean enableTokenRevocation

Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.

explicitAuthFlows

java.util.List<java.lang.String> explicitAuthFlows

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are no longer supported in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with values including the ALLOW_ prefix.

Valid values include:

• ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.

• ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

• ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

• ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.

• ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

idTokenValidity

java.lang.Integer idTokenValidity

The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

Constraints:
Range: 1 - 86400

lastModifiedDate

java.util.Date lastModifiedDate

The date the user pool client was last modified.

logoutURLs

java.util.List<java.lang.String> logoutURLs

A list of allowed logout URLs for the IdPs.

preventUserExistenceErrors

java.lang.String preventUserExistenceErrors

Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.

Valid values include:

• ENABLED - This prevents user existence-related errors.

• LEGACY - This represents the old behavior of Amazon Cognito where user existence related errors aren't prevented.

Constraints:
Allowed Values: LEGACY, ENABLED

readAttributes

java.util.List<java.lang.String> readAttributes

The Read-only attributes.

refreshTokenValidity

java.lang.Integer refreshTokenValidity

The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days.

The default time unit for RefreshTokenValidity in an API request is days. You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.

Constraints:
Range: 0 - 315360000

supportedIdentityProviders

java.util.List<java.lang.String> supportedIdentityProviders

A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google, SignInWithApple, LoginWithAmazon, and the names of your own SAML and OIDC providers.

tokenValidityUnits

TokenValidityUnitsType tokenValidityUnits

The time units used to specify the token validity times of each token type: ID, access, and refresh.

userPoolId

java.lang.String userPoolId

The user pool ID for the user pool client.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

writeAttributes

java.util.List<java.lang.String> writeAttributes

The writeable attributes.

Class com.amazonaws.services.cognitoidentityprovider.model.UserPoolDescriptionType extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The date the user pool description was created.

id

java.lang.String id

The ID in a user pool description.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

lambdaConfig

LambdaConfigType lambdaConfig

The Lambda configuration information in a user pool description.

lastModifiedDate

java.util.Date lastModifiedDate

The date the user pool description was last modified.

name

java.lang.String name

The name in a user pool description.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

status

java.lang.String status

The user pool status in a user pool description.

Constraints:
Allowed Values: Enabled, Disabled

Class com.amazonaws.services.cognitoidentityprovider.model.UserPoolPolicyType extends java.lang.Object implements Serializable

Serialized Fields

passwordPolicy

PasswordPolicyType passwordPolicy

The password policy.

Class com.amazonaws.services.cognitoidentityprovider.model.UserPoolTaggingException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentityprovider.model.UserPoolType extends java.lang.Object implements Serializable

Serialized Fields

accountRecoverySetting

AccountRecoverySettingType accountRecoverySetting

The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

adminCreateUserConfig

AdminCreateUserConfigType adminCreateUserConfig

The configuration for AdminCreateUser requests.

aliasAttributes

java.util.List<java.lang.String> aliasAttributes

The attributes that are aliased in a user pool.

arn

java.lang.String arn

The Amazon Resource Name (ARN) for the user pool.

Constraints:
Length: 20 - 2048
Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

autoVerifiedAttributes

java.util.List<java.lang.String> autoVerifiedAttributes

The attributes that are auto-verified in a user pool.

creationDate

java.util.Date creationDate

The date the user pool was created.

customDomain

java.lang.String customDomain

A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

Constraints:
Length: 1 - 63
Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

deviceConfiguration

DeviceConfigurationType deviceConfiguration

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

domain

java.lang.String domain

The domain prefix, if the user pool has a domain associated with it.

Constraints:
Length: 1 - 63
Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

emailConfiguration

EmailConfigurationType emailConfiguration

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages tfrom your user pool.

emailConfigurationFailure

java.lang.String emailConfigurationFailure

Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.

emailVerificationMessage

java.lang.String emailVerificationMessage

This parameter is no longer used. See VerificationMessageTemplateType.

Constraints:
Length: 6 - 20000
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{ N}\p{P}\s*]*

emailVerificationSubject

java.lang.String emailVerificationSubject

This parameter is no longer used. See VerificationMessageTemplateType.

Constraints:
Length: 1 - 140
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+

estimatedNumberOfUsers

java.lang.Integer estimatedNumberOfUsers

A number estimating the size of the user pool.

id

java.lang.String id

The ID of the user pool.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

lambdaConfig

LambdaConfigType lambdaConfig

The Lambda triggers associated with the user pool.

lastModifiedDate

java.util.Date lastModifiedDate

The date the user pool was last modified.

mfaConfiguration

java.lang.String mfaConfiguration

Can be one of the following values:

• OFF - MFA tokens aren't required and can't be specified during user registration.

• ON - MFA tokens are required for all user registrations. You can only specify required when you're initially creating a user pool.

• OPTIONAL - Users have the option when registering to create an MFA token.

Constraints:
Allowed Values: OFF, ON, OPTIONAL

name

java.lang.String name

The name of the user pool.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

policies

UserPoolPolicyType policies

The policies associated with the user pool.

schemaAttributes

java.util.List<SchemaAttributeType> schemaAttributes

A container with the schema attributes of a user pool.

smsAuthenticationMessage

java.lang.String smsAuthenticationMessage

The contents of the SMS authentication message.

Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*

smsConfiguration

SmsConfigurationType smsConfiguration

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

smsConfigurationFailure

java.lang.String smsConfigurationFailure

The reason why the SMS configuration can't send the messages to your users.

This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.

InvalidSmsRoleAccessPolicyException

The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.

SNSSandbox

The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.

smsVerificationMessage

java.lang.String smsVerificationMessage

This parameter is no longer used. See VerificationMessageTemplateType.

Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*

status

java.lang.String status

The status of a user pool.

Constraints:
Allowed Values: Enabled, Disabled

userAttributeUpdateSettings

UserAttributeUpdateSettingsType userAttributeUpdateSettings

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

usernameAttributes

java.util.List<java.lang.String> usernameAttributes

Specifies whether a user can use an email address or phone number as a username when they sign up.

usernameConfiguration

UsernameConfigurationType usernameConfiguration

Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

userPoolAddOns

UserPoolAddOnsType userPoolAddOns

The user pool add-ons.

userPoolTags

java.util.Map<java.lang.String,java.lang.String> userPoolTags

The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

verificationMessageTemplate

VerificationMessageTemplateType verificationMessageTemplate

The template for verification messages.

Class com.amazonaws.services.cognitoidentityprovider.model.UserType extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.List<AttributeType> attributes

A container with information about the user type attributes.

enabled

java.lang.Boolean enabled

Specifies whether the user is enabled.

mFAOptions

java.util.List<MFAOptionType> mFAOptions

The MFA options for the user.

userCreateDate

java.util.Date userCreateDate

The creation date of the user.

userLastModifiedDate

java.util.Date userLastModifiedDate

The last modified date of the user.

username

java.lang.String username

The user name of the user you want to describe.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

userStatus

java.lang.String userStatus

The user status. This can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• EXTERNAL_PROVIDER - User signed in with a third-party IdP.

• ARCHIVED - User is no longer active.

• UNKNOWN - User status isn't known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.

• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.

Constraints:
Allowed Values: UNCONFIRMED, CONFIRMED, ARCHIVED, COMPROMISED, UNKNOWN, RESET_REQUIRED, FORCE_CHANGE_PASSWORD

Class com.amazonaws.services.cognitoidentityprovider.model.VerificationMessageTemplateType extends java.lang.Object implements Serializable

Serialized Fields

defaultEmailOption

java.lang.String defaultEmailOption

The default email option.

Constraints:
Allowed Values: CONFIRM_WITH_LINK, CONFIRM_WITH_CODE

emailMessage

java.lang.String emailMessage

The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

Constraints:
Length: 6 - 20000
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{ N}\p{P}\s*]*

emailMessageByLink

java.lang.String emailMessageByLink

The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

Constraints:
Length: 6 - 20000
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{##[\p{L}\p{M}\p{S}\p{N}\p {P}\s*]*##\}[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*

emailSubject

java.lang.String emailSubject

The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

Constraints:
Length: 1 - 140
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+

emailSubjectByLink

java.lang.String emailSubjectByLink

The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

Constraints:
Length: 1 - 140
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+

smsMessage

java.lang.String smsMessage

The template for SMS messages that Amazon Cognito sends to your users.

Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*

Class com.amazonaws.services.cognitoidentityprovider.model.VerifySoftwareTokenRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A valid access token that Amazon Cognito issued to the user whose software token you want to verify.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

friendlyDeviceName

java.lang.String friendlyDeviceName

The friendly device name.

session

java.lang.String session

The session that should be passed both ways in challenge-response calls to the service.

Constraints:
Length: 20 - 2048

userCode

java.lang.String userCode

The one- time password computed using the secret code returned by AssociateSoftwareToken.

Constraints:
Length: 6 - 6
Pattern: [0-9]+

Class com.amazonaws.services.cognitoidentityprovider.model.VerifySoftwareTokenResult extends java.lang.Object implements Serializable

Serialized Fields

session

java.lang.String session

The session that should be passed both ways in challenge-response calls to the service.

Constraints:
Length: 20 - 2048

status

java.lang.String status

The status of the verify software token.

Constraints:
Allowed Values: SUCCESS, ERROR

Class com.amazonaws.services.cognitoidentityprovider.model.VerifyUserAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

attributeName

java.lang.String attributeName

The attribute name in the request to verify user attributes.

Constraints:
Length: 1 - 32
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

code

java.lang.String code

The verification code in the request to verify user attributes.

Constraints:
Length: 1 - 2048
Pattern: [\S]+

Class com.amazonaws.services.cognitoidentityprovider.model.VerifyUserAttributeResult extends java.lang.Object implements Serializable

Package com.amazonaws.services.comprehend.model

Class com.amazonaws.services.comprehend.model.AugmentedManifestsListItem extends java.lang.Object implements Serializable

Serialized Fields

annotationDataS3Uri

java.lang.String annotationDataS3Uri

The S3 prefix to the annotation files that are referred in the augmented manifest file.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

attributeNames

java.util.List<java.lang.String> attributeNames

The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.

If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.

If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.

documentType

java.lang.String documentType

The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

• PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

• SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

Constraints:
Allowed Values: PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT

s3Uri

java.lang.String s3Uri

The Amazon S3 location of the augmented manifest file.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

sourceDocumentsS3Uri

java.lang.String sourceDocumentsS3Uri

The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

split

java.lang.String split

The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.

TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.

TEST - all of the documents in the manifest will be used for testing.

Constraints:
Allowed Values: TRAIN, TEST

Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageItemResult extends java.lang.Object implements Serializable

Serialized Fields

index

java.lang.Integer index

The zero-based index of the document in the input list.

languages

java.util.List<DominantLanguage> languages

One or more DominantLanguage objects describing the dominant languages in the document.

Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

textList

java.util.List<java.lang.String> textList

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters.

Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageResult extends java.lang.Object implements Serializable

Serialized Fields

errorList

java.util.List<BatchItemError> errorList

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

resultList

java.util.List<BatchDetectDominantLanguageItemResult> resultList

A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesItemResult extends java.lang.Object implements Serializable

Serialized Fields

entities

java.util.List<Entity> entities

One or more Entity objects, one for each entity detected in the document.

index

java.lang.Integer index

The zero-based index of the document in the input list.

Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

textList

java.util.List<java.lang.String> textList

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.

Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesResult extends java.lang.Object implements Serializable

Serialized Fields

errorList

java.util.List<BatchItemError> errorList

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

resultList

java.util.List<BatchDetectEntitiesItemResult> resultList

A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesItemResult extends java.lang.Object implements Serializable

Serialized Fields

index

java.lang.Integer index

The zero-based index of the document in the input list.

keyPhrases

java.util.List<KeyPhrase> keyPhrases

One or more KeyPhrase objects, one for each key phrase detected in the document.

Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

textList

java.util.List<java.lang.String> textList

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.

Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesResult extends java.lang.Object implements Serializable

Serialized Fields

errorList

java.util.List<BatchItemError> errorList

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

resultList

java.util.List<BatchDetectKeyPhrasesItemResult> resultList

A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

Class com.amazonaws.services.comprehend.model.BatchDetectSentimentItemResult extends java.lang.Object implements Serializable

Serialized Fields

index

java.lang.Integer index

The zero-based index of the document in the input list.

sentiment

java.lang.String sentiment

The sentiment detected in the document.

Constraints:
Allowed Values: POSITIVE, NEGATIVE, NEUTRAL, MIXED

sentimentScore

SentimentScore sentimentScore

The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.

Class com.amazonaws.services.comprehend.model.BatchDetectSentimentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

textList

java.util.List<java.lang.String> textList

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Class com.amazonaws.services.comprehend.model.BatchDetectSentimentResult extends java.lang.Object implements Serializable

Serialized Fields

errorList

java.util.List<BatchItemError> errorList

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

resultList

java.util.List<BatchDetectSentimentItemResult> resultList

A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

Class com.amazonaws.services.comprehend.model.BatchDetectSyntaxItemResult extends java.lang.Object implements Serializable

Serialized Fields

index

java.lang.Integer index

The zero-based index of the document in the input list.

syntaxTokens

java.util.List<SyntaxToken> syntaxTokens

The syntax tokens for the words in the document, one token for each word.

Class com.amazonaws.services.comprehend.model.BatchDetectSyntaxRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.

Constraints:
Allowed Values: en, es, fr, de, it, pt

textList

java.util.List<java.lang.String> textList

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Class com.amazonaws.services.comprehend.model.BatchDetectSyntaxResult extends java.lang.Object implements Serializable

Serialized Fields

errorList

java.util.List<BatchItemError> errorList

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

resultList

java.util.List<BatchDetectSyntaxItemResult> resultList

A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

Class com.amazonaws.services.comprehend.model.BatchItemError extends java.lang.Object implements Serializable

Serialized Fields

errorCode

java.lang.String errorCode

The numeric error code of the error.

Constraints:
Length: 1 -

errorMessage

java.lang.String errorMessage

A text description of the error.

Constraints:
Length: 1 -

index

java.lang.Integer index

The zero-based index of the document in the input list.

Class com.amazonaws.services.comprehend.model.BatchSizeLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehend.model.ClassifierEvaluationMetrics extends java.lang.Object implements Serializable

Serialized Fields

accuracy

java.lang.Double accuracy

The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.

f1Score

java.lang.Double f1Score

A measure of how accurate the classifier results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

hammingLoss

java.lang.Double hammingLoss

Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better.

microF1Score

java.lang.Double microF1Score

A measure of how accurate the classifier results are for the test data. It is a combination of the Micro Precision and Micro Recall values. The Micro F1Score is the harmonic mean of the two scores. The highest score is 1, and the worst score is 0.

microPrecision

java.lang.Double microPrecision

A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from averaging the precision of all available labels, this is based on the overall score of all precision scores added together.

microRecall

java.lang.Double microRecall

A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. Specifically, this indicates how many of the correct categories in the text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together.

precision

java.lang.Double precision

A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones.

recall

java.lang.Double recall

A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results.

Class com.amazonaws.services.comprehend.model.ClassifierMetadata extends java.lang.Object implements Serializable

Serialized Fields

evaluationMetrics

ClassifierEvaluationMetrics evaluationMetrics

Describes the result metrics for the test data associated with an documentation classifier.

numberOfLabels

java.lang.Integer numberOfLabels

The number of labels in the input data.

numberOfTestDocuments

java.lang.Integer numberOfTestDocuments

The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents, up to 10,000 documents.

numberOfTrainedDocuments

java.lang.Integer numberOfTrainedDocuments

The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90 percent of the input documents.

Class com.amazonaws.services.comprehend.model.ClassifyDocumentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endpointArn

java.lang.String endpointArn

The Amazon Resource Number (ARN) of the endpoint. For information about endpoints, see Managing endpoints.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document -classifier-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*

text

java.lang.String text

The document text to be analyzed.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ClassifyDocumentResult extends java.lang.Object implements Serializable

Serialized Fields

classes

java.util.List<DocumentClass> classes

The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

labels

java.util.List<DocumentLabel> labels

The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

Class com.amazonaws.services.comprehend.model.ConcurrentModificationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehend.model.ContainsPiiEntitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language of the input documents. Currently, English is the only valid language.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

text

java.lang.String text

Creates a new document classification request to analyze a single document in real-time, returning personally identifiable information (PII) entity labels.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ContainsPiiEntitiesResult extends java.lang.Object implements Serializable

Serialized Fields

labels

java.util.List<EntityLabel> labels

The labels used in the document being analyzed. Individual labels represent personally identifiable information (PII) entity types.

Class com.amazonaws.services.comprehend.model.CreateDocumentClassifierRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

documentClassifierName

java.lang.String documentClassifierName

The name of the document classifier.

Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

inputDataConfig

DocumentClassifierInputDataConfig inputDataConfig

Specifies the format and location of the input data for the job.

languageCode

java.lang.String languageCode

The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

mode

java.lang.String mode

Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

Constraints:
Allowed Values: MULTI_CLASS, MULTI_LABEL

modelKmsKeyId

java.lang.String modelKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

modelPolicy

java.lang.String modelPolicy

The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model.

Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

'{"attribute": "value", "attribute": ["value"]}'

Constraints:
Length: 1 - 20000
Pattern: [ -ÿ]+

outputDataConfig

DocumentClassifierOutputDataConfig outputDataConfig

Enables the addition of output results configuration parameters for custom classifier jobs.

tags

java.util.List<Tag> tags

Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

versionName

java.lang.String versionName

The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/AWS Region.

Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.CreateDocumentClassifierResult extends java.lang.Object implements Serializable

Serialized Fields

documentClassifierArn

java.lang.String documentClassifierArn

The Amazon Resource Name (ARN) that identifies the document classifier.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document -classifier /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

Class com.amazonaws.services.comprehend.model.CreateEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

desiredInferenceUnits

java.lang.Integer desiredInferenceUnits

The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.

Constraints:
Range: 1 -

endpointName

java.lang.String endpointName

This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.

Constraints:
Length: - 40
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

modelArn

java.lang.String modelArn

The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document -classifier |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA- Z0-9](-*[a-zA-Z0-9])*)?

tags

java.util.List<Tag> tags

Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.

Class com.amazonaws.services.comprehend.model.CreateEndpointResult extends java.lang.Object implements Serializable

Serialized Fields

endpointArn

java.lang.String endpointArn

The Amazon Resource Number (ARN) of the endpoint being created.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document -classifier -endpoint|entity-recognizer-endpoint)/[a-zA-Z0-9](-*[a-zA-Z0-9])*

Class com.amazonaws.services.comprehend.model.CreateEntityRecognizerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

inputDataConfig

EntityRecognizerInputDataConfig inputDataConfig

Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.

languageCode

java.lang.String languageCode

You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). All documents must be in the same language.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

modelKmsKeyId

java.lang.String modelKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

modelPolicy

java.lang.String modelPolicy

The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another AWS account to import your custom model.

Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

'{"attribute": "value", "attribute": ["value"]}'

Constraints:
Length: 1 - 20000
Pattern: [ -ÿ]+

recognizerName

java.lang.String recognizerName

The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

tags

java.util.List<Tag> tags

Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

versionName

java.lang.String versionName

The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/ AWS Region.

Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.CreateEntityRecognizerResult extends java.lang.Object implements Serializable

Serialized Fields

entityRecognizerArn

java.lang.String entityRecognizerArn

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity -recognizer/ [a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

Class com.amazonaws.services.comprehend.model.DeleteDocumentClassifierRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

documentClassifierArn

java.lang.String documentClassifierArn

The Amazon Resource Name (ARN) that identifies the document classifier.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document -classifier /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

Class com.amazonaws.services.comprehend.model.DeleteDocumentClassifierResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.comprehend.model.DeleteEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endpointArn

java.lang.String endpointArn

The Amazon Resource Number (ARN) of the endpoint being deleted.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document -classifier -endpoint|entity-recognizer-endpoint)/[a-zA-Z0-9](-*[a-zA-Z0-9])*

Class com.amazonaws.services.comprehend.model.DeleteEndpointResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.comprehend.model.DeleteEntityRecognizerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

entityRecognizerArn

java.lang.String entityRecognizerArn

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity -recognizer/ [a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

Class com.amazonaws.services.comprehend.model.DeleteEntityRecognizerResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.comprehend.model.DeleteResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyRevisionId

java.lang.String policyRevisionId

The revision ID of the policy to delete.

Constraints:
Length: - 64
Pattern: [0-9A-Fa-f]+

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document -classifier |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA- Z0-9](-*[a-zA-Z0-9])*)?

Class com.amazonaws.services.comprehend.model.DeleteResourcePolicyResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.comprehend.model.DescribeDocumentClassificationJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.comprehend.model.DescribeDocumentClassificationJobResult extends java.lang.Object implements Serializable

Serialized Fields

documentClassificationJobProperties

DocumentClassificationJobProperties documentClassificationJobProperties

An object that describes the properties associated with the document classification job.

Class com.amazonaws.services.comprehend.model.DescribeDocumentClassifierRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

documentClassifierArn

java.lang.String documentClassifierArn

The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its response.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document -classifier /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

Class com.amazonaws.services.comprehend.model.DescribeDocumentClassifierResult extends java.lang.Object implements Serializable

Serialized Fields

documentClassifierProperties

DocumentClassifierProperties documentClassifierProperties

An object that contains the properties associated with a document classifier.

Class com.amazonaws.services.comprehend.model.DescribeDominantLanguageDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.comprehend.model.DescribeDominantLanguageDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

dominantLanguageDetectionJobProperties

DominantLanguageDetectionJobProperties dominantLanguageDetectionJobProperties

An object that contains the properties associated with a dominant language detection job.

Class com.amazonaws.services.comprehend.model.DescribeEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endpointArn

java.lang.String endpointArn

The Amazon Resource Number (ARN) of the endpoint being described.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document -classifier -endpoint|entity-recognizer-endpoint)/[a-zA-Z0-9](-*[a-zA-Z0-9])*

Class com.amazonaws.services.comprehend.model.DescribeEndpointResult extends java.lang.Object implements Serializable

Serialized Fields

endpointProperties

EndpointProperties endpointProperties

Describes information associated with the specific endpoint.

Class com.amazonaws.services.comprehend.model.DescribeEntitiesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.comprehend.model.DescribeEntitiesDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

entitiesDetectionJobProperties

EntitiesDetectionJobProperties entitiesDetectionJobProperties

An object that contains the properties associated with an entities detection job.

Class com.amazonaws.services.comprehend.model.DescribeEntityRecognizerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

entityRecognizerArn

java.lang.String entityRecognizerArn

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity -recognizer/ [a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

Class com.amazonaws.services.comprehend.model.DescribeEntityRecognizerResult extends java.lang.Object implements Serializable

Serialized Fields

entityRecognizerProperties

EntityRecognizerProperties entityRecognizerProperties

Describes information associated with an entity recognizer.

Class com.amazonaws.services.comprehend.model.DescribeEventsDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier of the events detection job.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.comprehend.model.DescribeEventsDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

eventsDetectionJobProperties

EventsDetectionJobProperties eventsDetectionJobProperties

An object that contains the properties associated with an event detection job.

Class com.amazonaws.services.comprehend.model.DescribeKeyPhrasesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.comprehend.model.DescribeKeyPhrasesDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

keyPhrasesDetectionJobProperties

KeyPhrasesDetectionJobProperties keyPhrasesDetectionJobProperties

An object that contains the properties associated with a key phrases detection job.

Class com.amazonaws.services.comprehend.model.DescribePiiEntitiesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.comprehend.model.DescribePiiEntitiesDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

piiEntitiesDetectionJobProperties

PiiEntitiesDetectionJobProperties piiEntitiesDetectionJobProperties

Provides information about a PII entities detection job.

Class com.amazonaws.services.comprehend.model.DescribeResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the policy to describe.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document -classifier |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA- Z0-9](-*[a-zA-Z0-9])*)?

Class com.amazonaws.services.comprehend.model.DescribeResourcePolicyResult extends java.lang.Object implements Serializable

Serialized Fields

creationTime

java.util.Date creationTime

The time at which the policy was created.

lastModifiedTime

java.util.Date lastModifiedTime

The time at which the policy was last modified.

policyRevisionId

java.lang.String policyRevisionId

The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a new revision ID, and it deletes the prior version of the policy.

Constraints:
Length: - 64
Pattern: [0-9A-Fa-f]+

resourcePolicy

java.lang.String resourcePolicy

The JSON body of the resource-based policy.

Constraints:
Length: 1 - 20000
Pattern: [ -ÿ]+

Class com.amazonaws.services.comprehend.model.DescribeSentimentDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.comprehend.model.DescribeSentimentDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

sentimentDetectionJobProperties

SentimentDetectionJobProperties sentimentDetectionJobProperties

An object that contains the properties associated with a sentiment detection job.

Class com.amazonaws.services.comprehend.model.DescribeTargetedSentimentDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.comprehend.model.DescribeTargetedSentimentDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

targetedSentimentDetectionJobProperties

TargetedSentimentDetectionJobProperties targetedSentimentDetectionJobProperties

An object that contains the properties associated with a targeted sentiment detection job.

Class com.amazonaws.services.comprehend.model.DescribeTopicsDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier assigned by the user to the detection job.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.comprehend.model.DescribeTopicsDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

topicsDetectionJobProperties

TopicsDetectionJobProperties topicsDetectionJobProperties

The list of properties for the requested job.

Class com.amazonaws.services.comprehend.model.DetectDominantLanguageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

text

java.lang.String text

A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.DetectDominantLanguageResult extends java.lang.Object implements Serializable

Serialized Fields

languages

java.util.List<DominantLanguage> languages

The languages that Amazon Comprehend detected in the input text. For each language, the response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend has in the accuracy of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.

Class com.amazonaws.services.comprehend.model.DetectEntitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endpointArn

java.lang.String endpointArn

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

For information about endpoints, see Managing endpoints.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity -recognizer-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*

languageCode

java.lang.String languageCode

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

text

java.lang.String text

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.DetectEntitiesResult extends java.lang.Object implements Serializable

Serialized Fields

entities

java.util.List<Entity> entities

A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see how-entities.

Class com.amazonaws.services.comprehend.model.DetectKeyPhrasesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

text

java.lang.String text

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.DetectKeyPhrasesResult extends java.lang.Object implements Serializable

Serialized Fields

keyPhrases

java.util.List<KeyPhrase> keyPhrases

A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

Class com.amazonaws.services.comprehend.model.DetectPiiEntitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language of the input documents. Currently, English is the only valid language.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

text

java.lang.String text

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.DetectPiiEntitiesResult extends java.lang.Object implements Serializable

Serialized Fields

entities

java.util.List<PiiEntity> entities

A collection of PII entities identified in the input text. For each entity, the response provides the entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

Class com.amazonaws.services.comprehend.model.DetectSentimentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

text

java.lang.String text

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.DetectSentimentResult extends java.lang.Object implements Serializable

Serialized Fields

sentiment

java.lang.String sentiment

The inferred sentiment that Amazon Comprehend has the highest level of confidence in.

Constraints:
Allowed Values: POSITIVE, NEGATIVE, NEUTRAL, MIXED

sentimentScore

SentimentScore sentimentScore

An object that lists the sentiments, and their corresponding confidence levels.

Class com.amazonaws.services.comprehend.model.DetectSyntaxRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language code of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt").

Constraints:
Allowed Values: en, es, fr, de, it, pt

text

java.lang.String text

A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.DetectSyntaxResult extends java.lang.Object implements Serializable

Serialized Fields

syntaxTokens

java.util.List<SyntaxToken> syntaxTokens

A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see how-syntax.

Class com.amazonaws.services.comprehend.model.DocumentClass extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the class.

Constraints:
Length: 1 -

score

java.lang.Float score

The confidence score that Amazon Comprehend has this class correctly attributed.

Class com.amazonaws.services.comprehend.model.DocumentClassificationJobFilter extends java.lang.Object implements Serializable

Serialized Fields

jobName

java.lang.String jobName

Filters on the name of the job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

Filters the list based on job status. Returns only jobs with the specified status.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

submitTimeAfter

java.util.Date submitTimeAfter

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

submitTimeBefore

java.util.Date submitTimeBefore

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

Class com.amazonaws.services.comprehend.model.DocumentClassificationJobProperties extends java.lang.Object implements Serializable

Serialized Fields

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

documentClassifierArn

java.lang.String documentClassifierArn

The Amazon Resource Name (ARN) that identifies the document classifier.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document -classifier /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

endTime

java.util.Date endTime

The time that the document classification job completed.

inputDataConfig

InputDataConfig inputDataConfig

The input data configuration that you supplied when you created the document classification job.

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

The identifier assigned to the document classification job.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobName

java.lang.String jobName

The name that you assigned to the document classification job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

message

java.lang.String message

A description of the status of the job.

outputDataConfig

OutputDataConfig outputDataConfig

The output data configuration that you supplied when you created the document classification job.

submitTime

java.util.Date submitTime

The time that the document classification job was submitted for processing.

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.DocumentClassifierFilter extends java.lang.Object implements Serializable

Serialized Fields

documentClassifierName

java.lang.String documentClassifierName

The name that you assigned to the document classifier

Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

status

java.lang.String status

Filters the list of classifiers based on status.

Constraints:
Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED

submitTimeAfter

java.util.Date submitTimeAfter

Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted after the specified time. Classifiers are returned in descending order, newest to oldest.

submitTimeBefore

java.util.Date submitTimeBefore

Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted before the specified time. Classifiers are returned in ascending order, oldest to newest.

Class com.amazonaws.services.comprehend.model.DocumentClassifierInputDataConfig extends java.lang.Object implements Serializable

Serialized Fields

augmentedManifests

java.util.List<AugmentedManifestsListItem> augmentedManifests

A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.

dataFormat

java.lang.String dataFormat

The format of your training data:

• COMPREHEND_CSV: A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the S3Uri parameter in your request.

• AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels.

  If you use this value, you must provide the AugmentedManifests parameter in your request.

If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.

Constraints:
Allowed Values: COMPREHEND_CSV, AUGMENTED_MANIFEST

labelDelimiter

java.lang.String labelDelimiter

Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.

Constraints:
Length: 1 - 1
Pattern: ^[ ~!@#$%^*\-_+=|\\:;\t>?/]$

s3Uri

java.lang.String s3Uri

The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.

For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

This parameter is required if you set DataFormat to COMPREHEND_CSV.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

testS3Uri

java.lang.String testS3Uri

The Amazon S3 URI for the input data. The Amazon S3 bucket must be in the same AWS Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

Class com.amazonaws.services.comprehend.model.DocumentClassifierOutputDataConfig extends java.lang.Object implements Serializable

Serialized Fields

kmsKeyId

java.lang.String kmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

• KMS Key Alias: "alias/ExampleAlias"

• ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

s3Uri

java.lang.String s3Uri

When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.

When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the confusion matrix.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

Class com.amazonaws.services.comprehend.model.DocumentClassifierProperties extends java.lang.Object implements Serializable

Serialized Fields

classifierMetadata

ClassifierMetadata classifierMetadata

Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

documentClassifierArn

java.lang.String documentClassifierArn

The Amazon Resource Name (ARN) that identifies the document classifier.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document -classifier /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

endTime

java.util.Date endTime

The time that training the document classifier completed.

inputDataConfig

DocumentClassifierInputDataConfig inputDataConfig

The input data configuration that you supplied when you created the document classifier for training.

languageCode

java.lang.String languageCode

The language code for the language of the documents that the classifier was trained on.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

message

java.lang.String message

Additional information about the status of the classifier.

mode

java.lang.String mode

Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

Constraints:
Allowed Values: MULTI_CLASS, MULTI_LABEL

modelKmsKeyId

java.lang.String modelKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

outputDataConfig

DocumentClassifierOutputDataConfig outputDataConfig

Provides output results configuration parameters for custom classifier jobs.

sourceModelArn

java.lang.String sourceModelArn

The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the document classifier model in your AWS account.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document -classifier /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

status

java.lang.String status

The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

Constraints:
Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED

submitTime

java.util.Date submitTime

The time that the document classifier was submitted for training.

trainingEndTime

java.util.Date trainingEndTime

The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

trainingStartTime

java.util.Date trainingStartTime

Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

versionName

java.lang.String versionName

The version name that you assigned to the document classifier.

Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.DocumentClassifierSummary extends java.lang.Object implements Serializable

Serialized Fields

documentClassifierName

java.lang.String documentClassifierName

The name that you assigned the document classifier.

Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

latestVersionCreatedAt

java.util.Date latestVersionCreatedAt

The time that the latest document classifier version was submitted for processing.

latestVersionName

java.lang.String latestVersionName

The version name you assigned to the latest document classifier version.

Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

latestVersionStatus

java.lang.String latestVersionStatus

Provides the status of the latest document classifier version.

Constraints:
Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED

numberOfVersions

java.lang.Integer numberOfVersions

The number of versions you created.

Class com.amazonaws.services.comprehend.model.DocumentLabel extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the label.

Constraints:
Length: 1 -

score

java.lang.Float score

The confidence score that Amazon Comprehend has this label correctly attributed.

Class com.amazonaws.services.comprehend.model.DocumentReaderConfig extends java.lang.Object implements Serializable

Serialized Fields

documentReadAction

java.lang.String documentReadAction

This enum field will start with two values which will apply to PDFs:

• TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText for PDF documents per page.

• TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF documents per page.

Constraints:
Allowed Values: TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT

documentReadMode

java.lang.String documentReadMode

This enum field provides two values:

• SERVICE_DEFAULT - use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIs

• FORCE_DOCUMENT_READ_ACTION - Always use specified action for DocumentReadAction, including Digital PDF.

Constraints:
Allowed Values: SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION

featureTypes

java.util.List<java.lang.String> featureTypes

Specifies how the text in an input file should be processed:

Class com.amazonaws.services.comprehend.model.DominantLanguage extends java.lang.Object implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The RFC 5646 language code for the dominant language. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.

Constraints:
Length: 1 -

score

java.lang.Float score

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

Class com.amazonaws.services.comprehend.model.DominantLanguageDetectionJobFilter extends java.lang.Object implements Serializable

Serialized Fields

jobName

java.lang.String jobName

Filters on the name of the job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

Filters the list of jobs based on job status. Returns only jobs with the specified status.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

submitTimeAfter

java.util.Date submitTimeAfter

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

submitTimeBefore

java.util.Date submitTimeBefore

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

Class com.amazonaws.services.comprehend.model.DominantLanguageDetectionJobProperties extends java.lang.Object implements Serializable

Serialized Fields

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

endTime

java.util.Date endTime

The time that the dominant language detection job completed.

inputDataConfig

InputDataConfig inputDataConfig

The input data configuration that you supplied when you created the dominant language detection job.

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

The identifier assigned to the dominant language detection job.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobName

java.lang.String jobName

The name that you assigned to the dominant language detection job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The current status of the dominant language detection job. If the status is FAILED, the Message field shows the reason for the failure.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

message

java.lang.String message

A description for the status of a job.

outputDataConfig

OutputDataConfig outputDataConfig

The output data configuration that you supplied when you created the dominant language detection job.

submitTime

java.util.Date submitTime

The time that the dominant language detection job was submitted for processing.

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.EndpointFilter extends java.lang.Object implements Serializable

Serialized Fields

creationTimeAfter

java.util.Date creationTimeAfter

Specifies a date after which the returned endpoint or endpoints were created.

creationTimeBefore

java.util.Date creationTimeBefore

Specifies a date before which the returned endpoint or endpoints were created.

modelArn

java.lang.String modelArn

The Amazon Resource Number (ARN) of the model to which the endpoint is attached.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document -classifier |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA- Z0-9](-*[a-zA-Z0-9])*)?

status

java.lang.String status

Specifies the status of the endpoint being returned. Possible values are: Creating, Ready, Updating, Deleting, Failed.

Constraints:
Allowed Values: CREATING, DELETING, FAILED, IN_SERVICE, UPDATING

Class com.amazonaws.services.comprehend.model.EndpointProperties extends java.lang.Object implements Serializable

Serialized Fields

creationTime

java.util.Date creationTime

The creation date and time of the endpoint.

currentInferenceUnits

java.lang.Integer currentInferenceUnits

The number of inference units currently used by the model using this endpoint.

Constraints:
Range: 1 -

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

desiredDataAccessRoleArn

java.lang.String desiredDataAccessRoleArn

Data access role ARN to use in case the new model is encrypted with a customer KMS key.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

desiredInferenceUnits

java.lang.Integer desiredInferenceUnits

The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.

Constraints:
Range: 1 -

desiredModelArn

java.lang.String desiredModelArn

ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document -classifier |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA- Z0-9](-*[a-zA-Z0-9])*)?

endpointArn

java.lang.String endpointArn

The Amazon Resource Number (ARN) of the endpoint.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document -classifier -endpoint|entity-recognizer-endpoint)/[a-zA-Z0-9](-*[a-zA-Z0-9])*

lastModifiedTime

java.util.Date lastModifiedTime

The date and time that the endpoint was last modified.

message

java.lang.String message

Specifies a reason for failure in cases of Failed status.

modelArn

java.lang.String modelArn

The Amazon Resource Number (ARN) of the model to which the endpoint is attached.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document -classifier |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA- Z0-9](-*[a-zA-Z0-9])*)?

status

java.lang.String status

Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.

Constraints:
Allowed Values: CREATING, DELETING, FAILED, IN_SERVICE, UPDATING

Class com.amazonaws.services.comprehend.model.EntitiesDetectionJobFilter extends java.lang.Object implements Serializable

Serialized Fields

jobName

java.lang.String jobName

Filters on the name of the job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

Filters the list of jobs based on job status. Returns only jobs with the specified status.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

submitTimeAfter

java.util.Date submitTimeAfter

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

submitTimeBefore

java.util.Date submitTimeBefore

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

Class com.amazonaws.services.comprehend.model.EntitiesDetectionJobProperties extends java.lang.Object implements Serializable

Serialized Fields

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

endTime

java.util.Date endTime

The time that the entities detection job completed

entityRecognizerArn

java.lang.String entityRecognizerArn

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity -recognizer/ [a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

inputDataConfig

InputDataConfig inputDataConfig

The input data configuration that you supplied when you created the entities detection job.

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

The identifier assigned to the entities detection job.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobName

java.lang.String jobName

The name that you assigned the entities detection job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The current status of the entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

languageCode

java.lang.String languageCode

The language code of the input documents.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

message

java.lang.String message

A description of the status of a job.

outputDataConfig

OutputDataConfig outputDataConfig

The output data configuration that you supplied when you created the entities detection job.

submitTime

java.util.Date submitTime

The time that the entities detection job was submitted for processing.

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.Entity extends java.lang.Object implements Serializable

Serialized Fields

beginOffset

java.lang.Integer beginOffset

A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

endOffset

java.lang.Integer endOffset

A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

score

java.lang.Float score

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

text

java.lang.String text

The text of the entity.

Constraints:
Length: 1 -

type

java.lang.String type

The entity's type.

Constraints:
Allowed Values: PERSON, LOCATION, ORGANIZATION, COMMERCIAL_ITEM, EVENT, DATE, QUANTITY, TITLE, OTHER

Class com.amazonaws.services.comprehend.model.EntityLabel extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the label.

Constraints:
Allowed Values: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL, LICENSE_PLATE, VEHICLE_IDENTIFICATION_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER, IN_PERMANENT_ACCOUNT_NUMBER, IN_NREGA, INTERNATIONAL_BANK_ACCOUNT_NUMBER, SWIFT_CODE, UK_NATIONAL_HEALTH_SERVICE_NUMBER, CA_HEALTH_NUMBER, IN_AADHAAR, IN_VOTER_NUMBER

score

java.lang.Float score

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

Class com.amazonaws.services.comprehend.model.EntityRecognizerAnnotations extends java.lang.Object implements Serializable

Serialized Fields

s3Uri

java.lang.String s3Uri

Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

testS3Uri

java.lang.String testS3Uri

This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

Class com.amazonaws.services.comprehend.model.EntityRecognizerDocuments extends java.lang.Object implements Serializable

Serialized Fields

inputFormat

java.lang.String inputFormat

Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

Constraints:
Allowed Values: ONE_DOC_PER_FILE, ONE_DOC_PER_LINE

s3Uri

java.lang.String s3Uri

Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

testS3Uri

java.lang.String testS3Uri

Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

Class com.amazonaws.services.comprehend.model.EntityRecognizerEntityList extends java.lang.Object implements Serializable

Serialized Fields

s3Uri

java.lang.String s3Uri

Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API endpoint that you are calling.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

Class com.amazonaws.services.comprehend.model.EntityRecognizerEvaluationMetrics extends java.lang.Object implements Serializable

Serialized Fields

f1Score

java.lang.Double f1Score

A measure of how accurate the recognizer results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100, where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1, where 1 is the best score.

precision

java.lang.Double precision

A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

recall

java.lang.Double recall

A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.

Class com.amazonaws.services.comprehend.model.EntityRecognizerFilter extends java.lang.Object implements Serializable

Serialized Fields

recognizerName

java.lang.String recognizerName

The name that you assigned the entity recognizer.

Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

status

java.lang.String status

The status of an entity recognizer.

Constraints:
Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED

submitTimeAfter

java.util.Date submitTimeAfter

Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.

submitTimeBefore

java.util.Date submitTimeBefore

Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.

Class com.amazonaws.services.comprehend.model.EntityRecognizerInputDataConfig extends java.lang.Object implements Serializable

Serialized Fields

annotations

EntityRecognizerAnnotations annotations

The S3 location of the CSV file that annotates your training documents.

augmentedManifests

java.util.List<AugmentedManifestsListItem> augmentedManifests

A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.

dataFormat

java.lang.String dataFormat

The format of your training data:

• COMPREHEND_CSV: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list.

  If you use this value, you must provide your CSV file by using either the Annotations or EntityList parameters. You must provide your training documents by using the Documents parameter.

• AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document.

  If you use this value, you must provide the AugmentedManifests parameter in your request.

If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.

Constraints:
Allowed Values: COMPREHEND_CSV, AUGMENTED_MANIFEST

documents

EntityRecognizerDocuments documents

The S3 location of the folder that contains the training documents for your custom entity recognizer.

This parameter is required if you set DataFormat to COMPREHEND_CSV.

entityList

EntityRecognizerEntityList entityList

The S3 location of the CSV file that has the entity list for your custom entity recognizer.

entityTypes

java.util.List<EntityTypesListItem> entityTypes

The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don't specify are ignored.

A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break), \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma).

Class com.amazonaws.services.comprehend.model.EntityRecognizerMetadata extends java.lang.Object implements Serializable

Serialized Fields

entityTypes

java.util.List<EntityRecognizerMetadataEntityTypesListItem> entityTypes

Entity types from the metadata of an entity recognizer.

evaluationMetrics

EntityRecognizerEvaluationMetrics evaluationMetrics

Detailed information about the accuracy of an entity recognizer.

numberOfTestDocuments

java.lang.Integer numberOfTestDocuments

The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.

numberOfTrainedDocuments

java.lang.Integer numberOfTrainedDocuments

The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.

Class com.amazonaws.services.comprehend.model.EntityRecognizerMetadataEntityTypesListItem extends java.lang.Object implements Serializable

Serialized Fields

evaluationMetrics

EntityTypesEvaluationMetrics evaluationMetrics

Detailed information about the accuracy of the entity recognizer for a specific item on the list of entity types.

numberOfTrainMentions

java.lang.Integer numberOfTrainMentions

Indicates the number of times the given entity type was seen in the training data.

type

java.lang.String type

Type of entity from the list of entity types in the metadata of an entity recognizer.

Class com.amazonaws.services.comprehend.model.EntityRecognizerProperties extends java.lang.Object implements Serializable

Serialized Fields

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

endTime

java.util.Date endTime

The time that the recognizer creation completed.

entityRecognizerArn

java.lang.String entityRecognizerArn

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity -recognizer/ [a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

inputDataConfig

EntityRecognizerInputDataConfig inputDataConfig

The input data properties of an entity recognizer.

languageCode

java.lang.String languageCode

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

message

java.lang.String message

A description of the status of the recognizer.

modelKmsKeyId

java.lang.String modelKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

recognizerMetadata

EntityRecognizerMetadata recognizerMetadata

Provides information about an entity recognizer.

sourceModelArn

java.lang.String sourceModelArn

The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the entity recognizer model in your AWS account.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity -recognizer/ [a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

status

java.lang.String status

Provides the status of the entity recognizer.

Constraints:
Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED

submitTime

java.util.Date submitTime

The time that the recognizer was submitted for processing.

trainingEndTime

java.util.Date trainingEndTime

The time that training of the entity recognizer was completed.

trainingStartTime

java.util.Date trainingStartTime

The time that training of the entity recognizer started.

versionName

java.lang.String versionName

The version name you assigned to the entity recognizer.

Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.EntityRecognizerSummary extends java.lang.Object implements Serializable

Serialized Fields

latestVersionCreatedAt

java.util.Date latestVersionCreatedAt

The time that the latest entity recognizer version was submitted for processing.

latestVersionName

java.lang.String latestVersionName

The version name you assigned to the latest entity recognizer version.

Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

latestVersionStatus

java.lang.String latestVersionStatus

Provides the status of the latest entity recognizer version.

Constraints:
Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED

numberOfVersions

java.lang.Integer numberOfVersions

The number of versions you created.

recognizerName

java.lang.String recognizerName

The name that you assigned the entity recognizer.

Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

Class com.amazonaws.services.comprehend.model.EntityTypesEvaluationMetrics extends java.lang.Object implements Serializable

Serialized Fields

f1Score

java.lang.Double f1Score

A measure of how accurate the recognizer results are for a specific entity type in the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

precision

java.lang.Double precision

A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

recall

java.lang.Double recall

A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer returned most of the relevant results.

Class com.amazonaws.services.comprehend.model.EntityTypesListItem extends java.lang.Object implements Serializable

Serialized Fields

type

java.lang.String type

An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break, \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma).

Constraints:
Length: - 64
Pattern: ^(?![^\n\r\t,]*\\n|\\r|\\t)[^\n\r\t,]+$

Class com.amazonaws.services.comprehend.model.EventsDetectionJobFilter extends java.lang.Object implements Serializable

Serialized Fields

jobName

java.lang.String jobName

Filters on the name of the events detection job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

Filters the list of jobs based on job status. Returns only jobs with the specified status.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

submitTimeAfter

java.util.Date submitTimeAfter

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

submitTimeBefore

java.util.Date submitTimeBefore

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

Class com.amazonaws.services.comprehend.model.EventsDetectionJobProperties extends java.lang.Object implements Serializable

Serialized Fields

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identify and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

endTime

java.util.Date endTime

The time that the events detection job completed.

inputDataConfig

InputDataConfig inputDataConfig

The input data configuration that you supplied when you created the events detection job.

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

The identifier assigned to the events detection job.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobName

java.lang.String jobName

The name you assigned the events detection job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The current status of the events detection job.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

languageCode

java.lang.String languageCode

The language code of the input documents.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

message

java.lang.String message

A description of the status of the events detection job.

outputDataConfig

OutputDataConfig outputDataConfig

The output data configuration that you supplied when you created the events detection job.

submitTime

java.util.Date submitTime

The time that the events detection job was submitted for processing.

targetEventTypes

java.util.List<java.lang.String> targetEventTypes

The types of events that are detected by the job.

Class com.amazonaws.services.comprehend.model.ImportModelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that allows Amazon Comprehend to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

modelKmsKeyId

java.lang.String modelKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

modelName

java.lang.String modelName

The name to assign to the custom model that is created in Amazon Comprehend by this import.

Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

sourceModelArn

java.lang.String sourceModelArn

The Amazon Resource Name (ARN) of the custom model to import.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document -classifier |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA- Z0-9](-*[a-zA-Z0-9])*)?

tags

java.util.List<Tag> tags

Tags to be associated with the custom model that is created by this import. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

versionName

java.lang.String versionName

The version name given to the custom model that is created by this import. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/AWS Region.

Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

Class com.amazonaws.services.comprehend.model.ImportModelResult extends java.lang.Object implements Serializable

Serialized Fields

modelArn

java.lang.String modelArn

The Amazon Resource Name (ARN) of the custom model being imported.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document -classifier |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA- Z0-9](-*[a-zA-Z0-9])*)?

Class com.amazonaws.services.comprehend.model.InputDataConfig extends java.lang.Object implements Serializable

Serialized Fields

documentReaderConfig

DocumentReaderConfig documentReaderConfig

The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.

Use DocumentReaderConfig to provide specifications about how you want your inference documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.

inputFormat

java.lang.String inputFormat

Specifies how the text in an input file should be processed:

• ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

• ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

Constraints:
Allowed Values: ONE_DOC_PER_FILE, ONE_DOC_PER_LINE

s3Uri

java.lang.String s3Uri

The Amazon S3 URI for the input data. The URI must be in same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

Class com.amazonaws.services.comprehend.model.InternalServerException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehend.model.InvalidFilterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehend.model.InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehend.model.JobNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehend.model.KeyPhrase extends java.lang.Object implements Serializable

Serialized Fields

beginOffset

java.lang.Integer beginOffset

A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

endOffset

java.lang.Integer endOffset

A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

score

java.lang.Float score

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

text

java.lang.String text

The text of a key noun phrase.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.KeyPhrasesDetectionJobFilter extends java.lang.Object implements Serializable

Serialized Fields

jobName

java.lang.String jobName

Filters on the name of the job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

Filters the list of jobs based on job status. Returns only jobs with the specified status.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

submitTimeAfter

java.util.Date submitTimeAfter

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

submitTimeBefore

java.util.Date submitTimeBefore

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

Class com.amazonaws.services.comprehend.model.KeyPhrasesDetectionJobProperties extends java.lang.Object implements Serializable

Serialized Fields

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

endTime

java.util.Date endTime

The time that the key phrases detection job completed.

inputDataConfig

InputDataConfig inputDataConfig

The input data configuration that you supplied when you created the key phrases detection job.

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the key phrases detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

The identifier assigned to the key phrases detection job.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobName

java.lang.String jobName

The name that you assigned the key phrases detection job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

languageCode

java.lang.String languageCode

The language code of the input documents.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

message

java.lang.String message

A description of the status of a job.

outputDataConfig

OutputDataConfig outputDataConfig

The output data configuration that you supplied when you created the key phrases detection job.

submitTime

java.util.Date submitTime

The time that the key phrases detection job was submitted for processing.

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.KmsKeyValidationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehend.model.ListDocumentClassificationJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

DocumentClassificationJobFilter filter

Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in each page. The default is 100.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListDocumentClassificationJobsResult extends java.lang.Object implements Serializable

Serialized Fields

documentClassificationJobPropertiesList

java.util.List<DocumentClassificationJobProperties> documentClassificationJobPropertiesList

A list containing the properties of each job returned.

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListDocumentClassifiersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

DocumentClassifierFilter filter

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in each page. The default is 100.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListDocumentClassifiersResult extends java.lang.Object implements Serializable

Serialized Fields

documentClassifierPropertiesList

java.util.List<DocumentClassifierProperties> documentClassifierPropertiesList

A list containing the properties of each job returned.

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListDocumentClassifierSummariesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return on each page. The default is 100.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListDocumentClassifierSummariesResult extends java.lang.Object implements Serializable

Serialized Fields

documentClassifierSummariesList

java.util.List<DocumentClassifierSummary> documentClassifierSummariesList

The list of summaries of document classifiers.

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListDominantLanguageDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

DominantLanguageDetectionJobFilter filter

Filters that jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in each page. The default is 100.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListDominantLanguageDetectionJobsResult extends java.lang.Object implements Serializable

Serialized Fields

dominantLanguageDetectionJobPropertiesList

java.util.List<DominantLanguageDetectionJobProperties> dominantLanguageDetectionJobPropertiesList

A list containing the properties of each job that is returned.

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListEndpointsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

EndpointFilter filter

Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and time that they were created. You can only set one filter at a time.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in each page. The default is 100.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListEndpointsResult extends java.lang.Object implements Serializable

Serialized Fields

endpointPropertiesList

java.util.List<EndpointProperties> endpointPropertiesList

Displays a list of endpoint properties being retrieved by the service in response to the request.

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListEntitiesDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

EntitiesDetectionJobFilter filter

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in each page. The default is 100.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListEntitiesDetectionJobsResult extends java.lang.Object implements Serializable

Serialized Fields

entitiesDetectionJobPropertiesList

java.util.List<EntitiesDetectionJobProperties> entitiesDetectionJobPropertiesList

A list containing the properties of each job that is returned.

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListEntityRecognizersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

EntityRecognizerFilter filter

Filters the list of entities returned. You can filter on Status, SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time.

maxResults

java.lang.Integer maxResults

The maximum number of results to return on each page. The default is 100.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListEntityRecognizersResult extends java.lang.Object implements Serializable

Serialized Fields

entityRecognizerPropertiesList

java.util.List<EntityRecognizerProperties> entityRecognizerPropertiesList

The list of properties of an entity recognizer.

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListEntityRecognizerSummariesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return on each page. The default is 100.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListEntityRecognizerSummariesResult extends java.lang.Object implements Serializable

Serialized Fields

entityRecognizerSummariesList

java.util.List<EntityRecognizerSummary> entityRecognizerSummariesList

The list entity recognizer summaries.

nextToken

java.lang.String nextToken

The list entity recognizer summaries.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListEventsDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

EventsDetectionJobFilter filter

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in each page.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListEventsDetectionJobsResult extends java.lang.Object implements Serializable

Serialized Fields

eventsDetectionJobPropertiesList

java.util.List<EventsDetectionJobProperties> eventsDetectionJobPropertiesList

A list containing the properties of each job that is returned.

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

KeyPhrasesDetectionJobFilter filter

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in each page. The default is 100.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListKeyPhrasesDetectionJobsResult extends java.lang.Object implements Serializable

Serialized Fields

keyPhrasesDetectionJobPropertiesList

java.util.List<KeyPhrasesDetectionJobProperties> keyPhrasesDetectionJobPropertiesList

A list containing the properties of each job that is returned.

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListPiiEntitiesDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

PiiEntitiesDetectionJobFilter filter

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in each page.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListPiiEntitiesDetectionJobsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

piiEntitiesDetectionJobPropertiesList

java.util.List<PiiEntitiesDetectionJobProperties> piiEntitiesDetectionJobPropertiesList

A list containing the properties of each job that is returned.

Class com.amazonaws.services.comprehend.model.ListSentimentDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

SentimentDetectionJobFilter filter

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in each page. The default is 100.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListSentimentDetectionJobsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

sentimentDetectionJobPropertiesList

java.util.List<SentimentDetectionJobProperties> sentimentDetectionJobPropertiesList

A list containing the properties of each job that is returned.

Class com.amazonaws.services.comprehend.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

Class com.amazonaws.services.comprehend.model.ListTagsForResourceResult extends java.lang.Object implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

tags

java.util.List<Tag> tags

Tags associated with the Amazon Comprehend resource being queried. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Class com.amazonaws.services.comprehend.model.ListTargetedSentimentDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

TargetedSentimentDetectionJobFilter filter

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in each page. The default is 100.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListTargetedSentimentDetectionJobsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

targetedSentimentDetectionJobPropertiesList

java.util.List<TargetedSentimentDetectionJobProperties> targetedSentimentDetectionJobPropertiesList

A list containing the properties of each job that is returned.

Class com.amazonaws.services.comprehend.model.ListTopicsDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

TopicsDetectionJobFilter filter

Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they were submitted. You can set only one filter at a time.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in each page. The default is 100.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

Class com.amazonaws.services.comprehend.model.ListTopicsDetectionJobsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

Identifies the next page of results to return.

Constraints:
Length: 1 -

topicsDetectionJobPropertiesList

java.util.List<TopicsDetectionJobProperties> topicsDetectionJobPropertiesList

A list containing the properties of each job that is returned.

Class com.amazonaws.services.comprehend.model.OutputDataConfig extends java.lang.Object implements Serializable

Serialized Fields

kmsKeyId

java.lang.String kmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

• KMS Key Alias: "alias/ExampleAlias"

• ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

s3Uri

java.lang.String s3Uri

When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

Class com.amazonaws.services.comprehend.model.PartOfSpeechTag extends java.lang.Object implements Serializable

Serialized Fields

score

java.lang.Float score

The confidence that Amazon Comprehend has that the part of speech was correctly identified.

tag

java.lang.String tag

Identifies the part of speech that the token represents.

Constraints:
Allowed Values: ADJ, ADP, ADV, AUX, CONJ, CCONJ, DET, INTJ, NOUN, NUM, O, PART, PRON, PROPN, PUNCT, SCONJ, SYM, VERB

Class com.amazonaws.services.comprehend.model.PiiEntitiesDetectionJobFilter extends java.lang.Object implements Serializable

Serialized Fields

jobName

java.lang.String jobName

Filters on the name of the job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

Filters the list of jobs based on job status. Returns only jobs with the specified status.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

submitTimeAfter

java.util.Date submitTimeAfter

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

submitTimeBefore

java.util.Date submitTimeBefore

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

Class com.amazonaws.services.comprehend.model.PiiEntitiesDetectionJobProperties extends java.lang.Object implements Serializable

Serialized Fields

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

endTime

java.util.Date endTime

The time that the PII entities detection job completed.

inputDataConfig

InputDataConfig inputDataConfig

The input properties for a PII entities detection job.

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

The identifier assigned to the PII entities detection job.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobName

java.lang.String jobName

The name that you assigned the PII entities detection job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

languageCode

java.lang.String languageCode

The language code of the input documents

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

message

java.lang.String message

A description of the status of a job.

mode

java.lang.String mode

Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

Constraints:
Allowed Values: ONLY_REDACTION, ONLY_OFFSETS

outputDataConfig

PiiOutputDataConfig outputDataConfig

The output data configuration that you supplied when you created the PII entities detection job.

redactionConfig

RedactionConfig redactionConfig

Provides configuration parameters for PII entity redaction.

This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.

submitTime

java.util.Date submitTime

The time that the PII entities detection job was submitted for processing.

Class com.amazonaws.services.comprehend.model.PiiEntity extends java.lang.Object implements Serializable

Serialized Fields

beginOffset

java.lang.Integer beginOffset

A character offset in the input text that shows where the PII entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

endOffset

java.lang.Integer endOffset

A character offset in the input text that shows where the PII entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

score

java.lang.Float score

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

type

java.lang.String type

The entity's type.

Constraints:
Allowed Values: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL, LICENSE_PLATE, VEHICLE_IDENTIFICATION_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER, IN_PERMANENT_ACCOUNT_NUMBER, IN_NREGA, INTERNATIONAL_BANK_ACCOUNT_NUMBER, SWIFT_CODE, UK_NATIONAL_HEALTH_SERVICE_NUMBER, CA_HEALTH_NUMBER, IN_AADHAAR, IN_VOTER_NUMBER

Class com.amazonaws.services.comprehend.model.PiiOutputDataConfig extends java.lang.Object implements Serializable

Serialized Fields

kmsKeyId

java.lang.String kmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

s3Uri

java.lang.String s3Uri

When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.

For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

Class com.amazonaws.services.comprehend.model.PutResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyRevisionId

java.lang.String policyRevisionId

The revision ID that Amazon Comprehend assigned to the policy that you are updating. If you are creating a new policy that has no prior version, don't use this parameter. Amazon Comprehend creates the revision ID for you.

Constraints:
Length: - 64
Pattern: [0-9A-Fa-f]+

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the custom model to attach the policy to.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document -classifier |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA- Z0-9](-*[a-zA-Z0-9])*)?

resourcePolicy

java.lang.String resourcePolicy

The JSON resource-based policy to attach to your custom model. Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

'{"attribute": "value", "attribute": ["value"]}'

Constraints:
Length: 1 - 20000
Pattern: [ -ÿ]+

Class com.amazonaws.services.comprehend.model.PutResourcePolicyResult extends java.lang.Object implements Serializable

Serialized Fields

policyRevisionId

java.lang.String policyRevisionId

The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a new revision ID, and it deletes the prior version of the policy.

Constraints:
Length: - 64
Pattern: [0-9A-Fa-f]+

Class com.amazonaws.services.comprehend.model.RedactionConfig extends java.lang.Object implements Serializable

Serialized Fields

maskCharacter

java.lang.String maskCharacter

A character that replaces each character in the redacted PII entity.

Constraints:
Length: 1 - 1
Pattern: [!@#$%&*]

maskMode

java.lang.String maskMode

Specifies whether the PII entity is redacted with the mask character or the entity type.

Constraints:
Allowed Values: MASK, REPLACE_WITH_PII_ENTITY_TYPE

piiEntityTypes

java.util.List<java.lang.String> piiEntityTypes

An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.

Class com.amazonaws.services.comprehend.model.ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehend.model.ResourceLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehend.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehend.model.ResourceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehend.model.SentimentDetectionJobFilter extends java.lang.Object implements Serializable

Serialized Fields

jobName

java.lang.String jobName

Filters on the name of the job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

Filters the list of jobs based on job status. Returns only jobs with the specified status.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

submitTimeAfter

java.util.Date submitTimeAfter

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

submitTimeBefore

java.util.Date submitTimeBefore

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

Class com.amazonaws.services.comprehend.model.SentimentDetectionJobProperties extends java.lang.Object implements Serializable

Serialized Fields

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

endTime

java.util.Date endTime

The time that the sentiment detection job ended.

inputDataConfig

InputDataConfig inputDataConfig

The input data configuration that you supplied when you created the sentiment detection job.

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

The identifier assigned to the sentiment detection job.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobName

java.lang.String jobName

The name that you assigned to the sentiment detection job

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The current status of the sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

languageCode

java.lang.String languageCode

The language code of the input documents.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

message

java.lang.String message

A description of the status of a job.

outputDataConfig

OutputDataConfig outputDataConfig

The output data configuration that you supplied when you created the sentiment detection job.

submitTime

java.util.Date submitTime

The time that the sentiment detection job was submitted for processing.

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.SentimentScore extends java.lang.Object implements Serializable

Serialized Fields

mixed

java.lang.Float mixed

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.

negative

java.lang.Float negative

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.

neutral

java.lang.Float neutral

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.

positive

java.lang.Float positive

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.

Class com.amazonaws.services.comprehend.model.StartDocumentClassificationJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

documentClassifierArn

java.lang.String documentClassifierArn

The Amazon Resource Name (ARN) of the document classifier to use to process the job.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document -classifier /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

inputDataConfig

InputDataConfig inputDataConfig

Specifies the format and location of the input data for the job.

jobName

java.lang.String jobName

The identifier of the job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

outputDataConfig

OutputDataConfig outputDataConfig

Specifies where to send the output files.

tags

java.util.List<Tag> tags

Tags to be associated with the document classification job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.StartDocumentClassificationJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

The identifier generated for the job. To get the status of the job, use this identifier with the operation.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The status of the job:

• SUBMITTED - The job has been received and queued for processing.

• IN_PROGRESS - Amazon Comprehend is processing the job.

• COMPLETED - The job was successfully completed and the output is available.

• FAILED - The job did not complete. For details, use the operation.

• STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

• STOPPED - The job was successfully stopped without completing.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.comprehend.model.StartDominantLanguageDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing -permissions.html#auth-role-permissions.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

inputDataConfig

InputDataConfig inputDataConfig

Specifies the format and location of the input data for the job.

jobName

java.lang.String jobName

An identifier for the job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

outputDataConfig

OutputDataConfig outputDataConfig

Specifies where to send the output files.

tags

java.util.List<Tag> tags

Tags to be associated with the dominant language detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.StartDominantLanguageDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

The identifier generated for the job. To get the status of a job, use this identifier with the operation.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The status of the job.

• SUBMITTED - The job has been received and is queued for processing.

• IN_PROGRESS - Amazon Comprehend is processing the job.

• COMPLETED - The job was successfully completed and the output is available.

• FAILED - The job did not complete. To get details, use the operation.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.comprehend.model.StartEntitiesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing -permissions.html#auth-role-permissions.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

entityRecognizerArn

java.lang.String entityRecognizerArn

The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity -recognizer/ [a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

inputDataConfig

InputDataConfig inputDataConfig

Specifies the format and location of the input data for the job.

jobName

java.lang.String jobName

The identifier of the job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

languageCode

java.lang.String languageCode

The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

outputDataConfig

OutputDataConfig outputDataConfig

Specifies where to send the output files.

tags

java.util.List<Tag> tags

Tags to be associated with the entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.StartEntitiesDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

The identifier generated for the job. To get the status of job, use this identifier with the operation.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The status of the job.

• SUBMITTED - The job has been received and is queued for processing.

• IN_PROGRESS - Amazon Comprehend is processing the job.

• COMPLETED - The job was successfully completed and the output is available.

• FAILED - The job did not complete. To get details, use the operation.

• STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

• STOPPED - The job was successfully stopped without completing.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.comprehend.model.StartEventsDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

inputDataConfig

InputDataConfig inputDataConfig

Specifies the format and location of the input data for the job.

jobName

java.lang.String jobName

The identifier of the events detection job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

languageCode

java.lang.String languageCode

The language code of the input documents.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

outputDataConfig

OutputDataConfig outputDataConfig

Specifies where to send the output files.

tags

java.util.List<Tag> tags

Tags to be associated with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

targetEventTypes

java.util.List<java.lang.String> targetEventTypes

The types of events to detect in the input documents.

Class com.amazonaws.services.comprehend.model.StartEventsDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The status of the events detection job.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.comprehend.model.StartKeyPhrasesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing -permissions.html#auth-role-permissions.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

inputDataConfig

InputDataConfig inputDataConfig

Specifies the format and location of the input data for the job.

jobName

java.lang.String jobName

The identifier of the job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

languageCode

java.lang.String languageCode

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

outputDataConfig

OutputDataConfig outputDataConfig

Specifies where to send the output files.

tags

java.util.List<Tag> tags

Tags to be associated with the key phrases detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.StartKeyPhrasesDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the key phrase detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

The identifier generated for the job. To get the status of a job, use this identifier with the operation.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The status of the job.

• SUBMITTED - The job has been received and is queued for processing.

• IN_PROGRESS - Amazon Comprehend is processing the job.

• COMPLETED - The job was successfully completed and the output is available.

• FAILED - The job did not complete. To get details, use the operation.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.comprehend.model.StartPiiEntitiesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

inputDataConfig

InputDataConfig inputDataConfig

The input properties for a PII entities detection job.

jobName

java.lang.String jobName

The identifier of the job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

languageCode

java.lang.String languageCode

The language of the input documents. Currently, English is the only valid language.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

mode

java.lang.String mode

Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

Constraints:
Allowed Values: ONLY_REDACTION, ONLY_OFFSETS

outputDataConfig

OutputDataConfig outputDataConfig

Provides configuration parameters for the output of PII entity detection jobs.

redactionConfig

RedactionConfig redactionConfig

Provides configuration parameters for PII entity redaction.

This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.

tags

java.util.List<Tag> tags

Tags to be associated with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Class com.amazonaws.services.comprehend.model.StartPiiEntitiesDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

The identifier generated for the job.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The status of the job.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.comprehend.model.StartSentimentDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing -permissions.html#auth-role-permissions.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

inputDataConfig

InputDataConfig inputDataConfig

Specifies the format and location of the input data for the job.

jobName

java.lang.String jobName

The identifier of the job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

languageCode

java.lang.String languageCode

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

outputDataConfig

OutputDataConfig outputDataConfig

Specifies where to send the output files.

tags

java.util.List<Tag> tags

Tags to be associated with the sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.StartSentimentDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

The identifier generated for the job. To get the status of a job, use this identifier with the operation.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The status of the job.

• SUBMITTED - The job has been received and is queued for processing.

• IN_PROGRESS - Amazon Comprehend is processing the job.

• COMPLETED - The job was successfully completed and the output is available.

• FAILED - The job did not complete. To get details, use the operation.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.comprehend.model.StartTargetedSentimentDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

inputDataConfig

InputDataConfig inputDataConfig

The input properties for an inference job.

jobName

java.lang.String jobName

The identifier of the job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

languageCode

java.lang.String languageCode

The language of the input documents. Currently, English is the only valid language.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

outputDataConfig

OutputDataConfig outputDataConfig

Specifies where to send the output files.

tags

java.util.List<Tag> tags

Tags to be associated with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.StartTargetedSentimentDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

The identifier generated for the job. To get the status of a job, use this identifier with the operation.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The status of the job.

• SUBMITTED - The job has been received and is queued for processing.

• IN_PROGRESS - Amazon Comprehend is processing the job.

• COMPLETED - The job was successfully completed and the output is available.

• FAILED - The job did not complete. To get details, use the operation.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.comprehend.model.StartTopicsDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing -permissions.html#auth-role-permissions.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

inputDataConfig

InputDataConfig inputDataConfig

Specifies the format and location of the input data for the job.

jobName

java.lang.String jobName

The identifier of the job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

numberOfTopics

java.lang.Integer numberOfTopics

The number of topics to detect.

Constraints:
Range: 1 - 100

outputDataConfig

OutputDataConfig outputDataConfig

Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

tags

java.util.List<Tag> tags

Tags to be associated with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.StartTopicsDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The status of the job:

• SUBMITTED - The job has been received and is queued for processing.

• IN_PROGRESS - Amazon Comprehend is processing the job.

• COMPLETED - The job was successfully completed and the output is available.

• FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob operation.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.comprehend.model.StopDominantLanguageDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier of the dominant language detection job to stop.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.comprehend.model.StopDominantLanguageDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier of the dominant language detection job to stop.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopDominantLanguageDetectionJob operation.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.comprehend.model.StopEntitiesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier of the entities detection job to stop.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.comprehend.model.StopEntitiesDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier of the entities detection job to stop.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopEntitiesDetectionJob operation.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.comprehend.model.StopEventsDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier of the events detection job to stop.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.comprehend.model.StopEventsDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier of the events detection job to stop.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The status of the events detection job.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.comprehend.model.StopKeyPhrasesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier of the key phrases detection job to stop.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.comprehend.model.StopKeyPhrasesDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier of the key phrases detection job to stop.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopKeyPhrasesDetectionJob operation.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.comprehend.model.StopPiiEntitiesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier of the PII entities detection job to stop.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.comprehend.model.StopPiiEntitiesDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier of the PII entities detection job to stop.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The status of the PII entities detection job.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.comprehend.model.StopSentimentDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier of the sentiment detection job to stop.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.comprehend.model.StopSentimentDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier of the sentiment detection job to stop.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.comprehend.model.StopTargetedSentimentDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier of the targeted sentiment detection job to stop.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.comprehend.model.StopTargetedSentimentDetectionJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier of the targeted sentiment detection job to stop.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.comprehend.model.StopTrainingDocumentClassifierRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

documentClassifierArn

java.lang.String documentClassifierArn

The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document -classifier /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

Class com.amazonaws.services.comprehend.model.StopTrainingDocumentClassifierResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.comprehend.model.StopTrainingEntityRecognizerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

entityRecognizerArn

java.lang.String entityRecognizerArn

The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity -recognizer/ [a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

Class com.amazonaws.services.comprehend.model.StopTrainingEntityRecognizerResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.comprehend.model.SyntaxToken extends java.lang.Object implements Serializable

Serialized Fields

beginOffset

java.lang.Integer beginOffset

The zero-based offset from the beginning of the source text to the first character in the word.

endOffset

java.lang.Integer endOffset

The zero-based offset from the beginning of the source text to the last character in the word.

partOfSpeech

PartOfSpeechTag partOfSpeech

Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see how-syntax.

text

java.lang.String text

The word that was recognized in the source text.

Constraints:
Length: 1 -

tokenId

java.lang.Integer tokenId

A unique identifier for a token.

Class com.amazonaws.services.comprehend.model.Tag extends java.lang.Object implements Serializable

Serialized Fields

key

java.lang.String key

The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

Constraints:
Length: 1 - 128

value

java.lang.String value

The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

Constraints:
Length: 0 - 256

Class com.amazonaws.services.comprehend.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

tags

java.util.List<Tag> tags

Tags being associated with a specific Amazon Comprehend resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource.

Class com.amazonaws.services.comprehend.model.TagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.comprehend.model.TargetedSentimentDetectionJobFilter extends java.lang.Object implements Serializable

Serialized Fields

jobName

java.lang.String jobName

Filters on the name of the job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

Filters the list of jobs based on job status. Returns only jobs with the specified status.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

submitTimeAfter

java.util.Date submitTimeAfter

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

submitTimeBefore

java.util.Date submitTimeBefore

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

Class com.amazonaws.services.comprehend.model.TargetedSentimentDetectionJobProperties extends java.lang.Object implements Serializable

Serialized Fields

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

endTime

java.util.Date endTime

The time that the targeted sentiment detection job ended.

inputDataConfig

InputDataConfig inputDataConfig

The input properties for an inference job.

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

The identifier assigned to the targeted sentiment detection job.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobName

java.lang.String jobName

The name that you assigned to the targeted sentiment detection job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

languageCode

java.lang.String languageCode

The language code of the input documents.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

message

java.lang.String message

A description of the status of a job.

outputDataConfig

OutputDataConfig outputDataConfig

Provides configuration parameters for the output of inference jobs.

submitTime

java.util.Date submitTime

The time that the targeted sentiment detection job was submitted for processing.

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.TextSizeLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehend.model.TooManyRequestsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehend.model.TooManyTagKeysException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehend.model.TooManyTagsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehend.model.TopicsDetectionJobFilter extends java.lang.Object implements Serializable

Serialized Fields

jobName

java.lang.String jobName

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

submitTimeAfter

java.util.Date submitTimeAfter

Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.

submitTimeBefore

java.util.Date submitTimeBefore

Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.

Class com.amazonaws.services.comprehend.model.TopicsDetectionJobProperties extends java.lang.Object implements Serializable

Serialized Fields

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

endTime

java.util.Date endTime

The time that the topic detection job was completed.

inputDataConfig

InputDataConfig inputDataConfig

The input data configuration supplied when you created the topic detection job.

jobArn

java.lang.String jobArn

The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

jobId

java.lang.String jobId

The identifier assigned to the topic detection job.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobName

java.lang.String jobName

The name of the topic detection job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED

message

java.lang.String message

A description for the status of a job.

numberOfTopics

java.lang.Integer numberOfTopics

The number of topics to detect supplied when you created the topic detection job. The default is 10.

outputDataConfig

OutputDataConfig outputDataConfig

The output data configuration supplied when you created the topic detection job.

submitTime

java.util.Date submitTime

The time that the topic detection job was submitted for processing.

volumeKmsKeyId

java.lang.String volumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Constraints:
Length: - 2048
Pattern: ^\p{ASCII}+$

vpcConfig

VpcConfig vpcConfig

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.

Class com.amazonaws.services.comprehend.model.UnsupportedLanguageException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehend.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you want to remove the tags.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA- Z0-9-]{1,64} /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

tagKeys

java.util.List<java.lang.String> tagKeys

The initial part of a key-value pair that forms a tag being removed from a given resource. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. Keys must be unique and cannot be duplicated for a particular resource.

Class com.amazonaws.services.comprehend.model.UntagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.comprehend.model.UpdateEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

desiredDataAccessRoleArn

java.lang.String desiredDataAccessRoleArn

Data access role ARN to use in case the new model is encrypted with a customer CMK.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

desiredInferenceUnits

java.lang.Integer desiredInferenceUnits

The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.

Constraints:
Range: 1 -

desiredModelArn

java.lang.String desiredModelArn

The ARN of the new model to use when updating an existing endpoint.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document -classifier |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA- Z0-9](-*[a-zA-Z0-9])*)?

endpointArn

java.lang.String endpointArn

The Amazon Resource Number (ARN) of the endpoint being updated.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document -classifier -endpoint|entity-recognizer-endpoint)/[a-zA-Z0-9](-*[a-zA-Z0-9])*

Class com.amazonaws.services.comprehend.model.UpdateEndpointResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.comprehend.model.VpcConfig extends java.lang.Object implements Serializable

Serialized Fields

securityGroupIds

java.util.List<java.lang.String> securityGroupIds

The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.

subnets

java.util.List<java.lang.String> subnets

The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.

Package com.amazonaws.services.connect.model

Class com.amazonaws.services.connect.model.AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connect.model.AgentInfo extends java.lang.Object implements Serializable

Serialized Fields

connectedToAgentTimestamp

java.util.Date connectedToAgentTimestamp

The timestamp when the contact was connected to the agent.

id

java.lang.String id

The identifier of the agent who accepted the contact.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.connect.model.AgentStatus extends java.lang.Object implements Serializable

Serialized Fields

agentStatusARN

java.lang.String agentStatusARN

The Amazon Resource Name (ARN) of the agent status.

agentStatusId

java.lang.String agentStatusId

The identifier of the agent status.

description

java.lang.String description

The description of the agent status.

Constraints:
Length: 1 - 250

displayOrder

java.lang.Integer displayOrder

The display order of the agent status.

Constraints:
Range: 1 - 50

name

java.lang.String name

The name of the agent status.

Constraints:
Length: 1 - 127

state

java.lang.String state

The state of the agent status.

Constraints:
Allowed Values: ENABLED, DISABLED

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

type

java.lang.String type

The type of agent status.

Constraints:
Allowed Values: ROUTABLE, CUSTOM, OFFLINE

Class com.amazonaws.services.connect.model.AgentStatusSummary extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) for the agent status.

id

java.lang.String id

The identifier for an agent status.

name

java.lang.String name

The name of the agent status.

Constraints:
Length: 1 - 127

type

java.lang.String type

The type of the agent status.

Constraints:
Allowed Values: ROUTABLE, CUSTOM, OFFLINE

Class com.amazonaws.services.connect.model.AnswerMachineDetectionConfig extends java.lang.Object implements Serializable

Serialized Fields

awaitAnswerMachinePrompt

java.lang.Boolean awaitAnswerMachinePrompt

Wait for the answering machine prompt.

enableAnswerMachineDetection

java.lang.Boolean enableAnswerMachineDetection

The flag to indicate if answer machine detection analysis needs to be performed for a voice call. If set to true, TrafficType must be set as CAMPAIGN.

Class com.amazonaws.services.connect.model.AssociateApprovedOriginRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

origin

java.lang.String origin

The domain to add to your allow list.

Constraints:
Length: - 267

Class com.amazonaws.services.connect.model.AssociateBotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

lexBot

LexBot lexBot

Configuration information of an Amazon Lex bot.

lexV2Bot

LexV2Bot lexV2Bot

The Amazon Lex V2 bot to associate with the instance.

Class com.amazonaws.services.connect.model.AssociateDefaultVocabularyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

languageCode

java.lang.String languageCode

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

Constraints:
Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN

vocabularyId

java.lang.String vocabularyId

The identifier of the custom vocabulary. If this is empty, the default is set to none.

Constraints:
Length: 1 - 500

Class com.amazonaws.services.connect.model.AssociateDefaultVocabularyResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connect.model.AssociateInstanceStorageConfigRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

resourceType

java.lang.String resourceType

A valid resource type.

Constraints:
Allowed Values: CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS

storageConfig

InstanceStorageConfig storageConfig

A valid storage type.

Class com.amazonaws.services.connect.model.AssociateInstanceStorageConfigResult extends java.lang.Object implements Serializable

Serialized Fields

associationId

java.lang.String associationId

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.AssociateLambdaFunctionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

functionArn

java.lang.String functionArn

The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.

Constraints:
Length: 1 - 140

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.AssociateLexBotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

lexBot

LexBot lexBot

The Amazon Lex bot to associate with the instance.

Class com.amazonaws.services.connect.model.AssociatePhoneNumberContactFlowRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactFlowId

java.lang.String contactFlowId

The identifier of the contact flow.

Constraints:
Length: - 500

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

phoneNumberId

java.lang.String phoneNumberId

A unique identifier for the phone number.

Class com.amazonaws.services.connect.model.AssociateQueueQuickConnectsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

queueId

java.lang.String queueId

The identifier for the queue.

quickConnectIds

java.util.List<java.lang.String> quickConnectIds

The quick connects to associate with this queue.

Class com.amazonaws.services.connect.model.AssociateRoutingProfileQueuesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

queueConfigs

java.util.List<RoutingProfileQueueConfig> queueConfigs

The queues to associate with this routing profile.

routingProfileId

java.lang.String routingProfileId

The identifier of the routing profile.

Class com.amazonaws.services.connect.model.AssociateSecurityKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

key

java.lang.String key

A valid security key in PEM format.

Constraints:
Length: 1 - 1024

Class com.amazonaws.services.connect.model.AssociateSecurityKeyResult extends java.lang.Object implements Serializable

Serialized Fields

associationId

java.lang.String associationId

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.AttachmentReference extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

Identifier of the attachment reference.

Constraints:
Length: 1 - 4096

status

java.lang.String status

Status of an attachment reference type.

Constraints:
Allowed Values: APPROVED, REJECTED

value

java.lang.String value

Contains the location path of the attachment reference.

Constraints:
Length: 0 - 4096

Class com.amazonaws.services.connect.model.Attribute extends java.lang.Object implements Serializable

Serialized Fields

attributeType

java.lang.String attributeType

The type of attribute.

Constraints:
Allowed Values: INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA, MULTI_PARTY_CONFERENCE

value

java.lang.String value

The value of the attribute.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.AvailableNumberSummary extends java.lang.Object implements Serializable

Serialized Fields

phoneNumber

java.lang.String phoneNumber

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

Constraints:
Pattern: \\+[1-9]\\d{1,14}$

phoneNumberCountryCode

java.lang.String phoneNumberCountryCode

The ISO country code.

Constraints:
Allowed Values: AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW

phoneNumberType

java.lang.String phoneNumberType

The type of phone number.

Constraints:
Allowed Values: TOLL_FREE, DID

Class com.amazonaws.services.connect.model.ChatMessage extends java.lang.Object implements Serializable

Serialized Fields

content

java.lang.String content

The content of the chat message.

Constraints:
Length: 1 - 1024

contentType

java.lang.String contentType

The type of the content. Supported types are text/plain.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.ChatStreamingConfiguration extends java.lang.Object implements Serializable

Serialized Fields

streamingEndpointArn

java.lang.String streamingEndpointArn

The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used to publish real-time message streaming for chat conversations.

Constraints:
Length: 1 - 350

Class com.amazonaws.services.connect.model.ClaimedPhoneNumberSummary extends java.lang.Object implements Serializable

Serialized Fields

phoneNumber

java.lang.String phoneNumber

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

Constraints:
Pattern: \\+[1-9]\\d{1,14}$

phoneNumberArn

java.lang.String phoneNumberArn

The Amazon Resource Name (ARN) of the phone number.

phoneNumberCountryCode

java.lang.String phoneNumberCountryCode

The ISO country code.

Constraints:
Allowed Values: AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW

phoneNumberDescription

java.lang.String phoneNumberDescription

The description of the phone number.

Constraints:
Length: 0 - 500
Pattern: ^[\W\S_]*

phoneNumberId

java.lang.String phoneNumberId

A unique identifier for the phone number.

phoneNumberStatus

PhoneNumberStatus phoneNumberStatus

The status of the phone number.

phoneNumberType

java.lang.String phoneNumberType

The type of phone number.

Constraints:
Allowed Values: TOLL_FREE, DID

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

targetArn

java.lang.String targetArn

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

Class com.amazonaws.services.connect.model.ClaimPhoneNumberRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:
Length: - 500

phoneNumber

java.lang.String phoneNumber

The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].

Constraints:
Pattern: \\+[1-9]\\d{1,14}$

phoneNumberDescription

java.lang.String phoneNumberDescription

The description of the phone number.

Constraints:
Length: 0 - 500
Pattern: ^[\W\S_]*

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

targetArn

java.lang.String targetArn

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

Class com.amazonaws.services.connect.model.ClaimPhoneNumberResult extends java.lang.Object implements Serializable

Serialized Fields

phoneNumberArn

java.lang.String phoneNumberArn

The Amazon Resource Name (ARN) of the phone number.

phoneNumberId

java.lang.String phoneNumberId

A unique identifier for the phone number.

Class com.amazonaws.services.connect.model.Contact extends java.lang.Object implements Serializable

Serialized Fields

agentInfo

AgentInfo agentInfo

Information about the agent who accepted the contact.

arn

java.lang.String arn

The Amazon Resource Name (ARN) for the contact.

channel

java.lang.String channel

How the contact reached your contact center.

Constraints:
Allowed Values: VOICE, CHAT, TASK

description

java.lang.String description

The description of the contact.

Constraints:
Length: 0 - 4096

disconnectTimestamp

java.util.Date disconnectTimestamp

The timestamp when the customer endpoint disconnected from Amazon Connect.

id

java.lang.String id

The identifier for the contact.

Constraints:
Length: 1 - 256

initialContactId

java.lang.String initialContactId

If this contact is related to other contacts, this is the ID of the initial contact.

Constraints:
Length: 1 - 256

initiationMethod

java.lang.String initiationMethod

Indicates how the contact was initiated.

Constraints:
Allowed Values: INBOUND, OUTBOUND, TRANSFER, QUEUE_TRANSFER, CALLBACK, API

initiationTimestamp

java.util.Date initiationTimestamp

The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived.

lastUpdateTimestamp

java.util.Date lastUpdateTimestamp

The timestamp when contact was last updated.

name

java.lang.String name

The name of the contact.

Constraints:
Length: 0 - 512

previousContactId

java.lang.String previousContactId

If this contact is not the first contact, this is the ID of the previous contact.

Constraints:
Length: 1 - 256

queueInfo

QueueInfo queueInfo

If this contact was queued, this contains information about the queue.

scheduledTimestamp

java.util.Date scheduledTimestamp

The timestamp, in Unix epoch time format, at which to start running the inbound flow.

Class com.amazonaws.services.connect.model.ContactFlow extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the contact flow.

content

java.lang.String content

The content of the contact flow.

description

java.lang.String description

The description of the contact flow.

id

java.lang.String id

The identifier of the contact flow.

Constraints:
Length: - 500

name

java.lang.String name

The name of the contact flow.

Constraints:
Length: 1 -

state

java.lang.String state

The type of contact flow.

Constraints:
Allowed Values: ACTIVE, ARCHIVED

tags

java.util.Map<java.lang.String,java.lang.String> tags

One or more tags.

type

java.lang.String type

The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide.

Constraints:
Allowed Values: CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER

Class com.amazonaws.services.connect.model.ContactFlowModule extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN).

content

java.lang.String content

The content of the contact flow module.

Constraints:
Length: 1 - 256000

description

java.lang.String description

The description of the contact flow module.

Constraints:
Length: 0 - 500
Pattern: .*\S.*

id

java.lang.String id

The identifier of the contact flow module.

Constraints:
Length: 1 - 256

name

java.lang.String name

The name of the contact flow module.

Constraints:
Length: 1 - 127
Pattern: .*\S.*

state

java.lang.String state

The type of contact flow module.

Constraints:
Allowed Values: ACTIVE, ARCHIVED

status

java.lang.String status

The status of the contact flow module.

Constraints:
Allowed Values: PUBLISHED, SAVED

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

Class com.amazonaws.services.connect.model.ContactFlowModuleSummary extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the contact flow module.

id

java.lang.String id

The identifier of the contact flow module.

Constraints:
Length: 1 - 256

name

java.lang.String name

The name of the contact flow module.

Constraints:
Length: 1 - 127
Pattern: .*\S.*

state

java.lang.String state

The type of contact flow module.

Constraints:
Allowed Values: ACTIVE, ARCHIVED

Class com.amazonaws.services.connect.model.ContactFlowNotPublishedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connect.model.ContactFlowSummary extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the contact flow.

contactFlowState

java.lang.String contactFlowState

The type of contact flow.

Constraints:
Allowed Values: ACTIVE, ARCHIVED

contactFlowType

java.lang.String contactFlowType

The type of contact flow.

Constraints:
Allowed Values: CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER

id

java.lang.String id

The identifier of the contact flow.

Constraints:
Length: - 500

name

java.lang.String name

The name of the contact flow.

Constraints:
Length: 1 -

Class com.amazonaws.services.connect.model.ContactNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connect.model.ControlPlaneTagFilter extends java.lang.Object implements Serializable

Serialized Fields

andConditions

java.util.List<TagCondition> andConditions

A list of conditions which would be applied together with an AND condition.

orConditions

java.util.List<java.util.List<TagCondition>> orConditions

A list of conditions which would be applied together with an OR condition.

tagCondition

TagCondition tagCondition

A leaf node condition which can be used to specify a tag condition.

Class com.amazonaws.services.connect.model.CreateAgentStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

The description of the status.

Constraints:
Length: 1 - 250

displayOrder

java.lang.Integer displayOrder

The display order of the status.

Constraints:
Range: 1 - 50

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

name

java.lang.String name

The name of the status.

Constraints:
Length: 1 - 127

state

java.lang.String state

The state of the status.

Constraints:
Allowed Values: ENABLED, DISABLED

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

Class com.amazonaws.services.connect.model.CreateAgentStatusResult extends java.lang.Object implements Serializable

Serialized Fields

agentStatusARN

java.lang.String agentStatusARN

The Amazon Resource Name (ARN) of the agent status.

agentStatusId

java.lang.String agentStatusId

The identifier of the agent status.

Class com.amazonaws.services.connect.model.CreateContactFlowModuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:
Length: - 500

content

java.lang.String content

The content of the contact flow module.

Constraints:
Length: 1 - 256000

description

java.lang.String description

The description of the contact flow module.

Constraints:
Length: 0 - 500
Pattern: .*\S.*

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

name

java.lang.String name

The name of the contact flow module.

Constraints:
Length: 1 - 127
Pattern: .*\S.*

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

Class com.amazonaws.services.connect.model.CreateContactFlowModuleResult extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the contact flow module.

id

java.lang.String id

The identifier of the contact flow module.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.connect.model.CreateContactFlowRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

content

java.lang.String content

The content of the contact flow.

description

java.lang.String description

The description of the contact flow.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance.

Constraints:
Length: 1 - 100

name

java.lang.String name

The name of the contact flow.

Constraints:
Length: 1 -

tags

java.util.Map<java.lang.String,java.lang.String> tags

One or more tags.

type

java.lang.String type

The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide.

Constraints:
Allowed Values: CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER

Class com.amazonaws.services.connect.model.CreateContactFlowResult extends java.lang.Object implements Serializable

Serialized Fields

contactFlowArn

java.lang.String contactFlowArn

The Amazon Resource Name (ARN) of the contact flow.

contactFlowId

java.lang.String contactFlowId

The identifier of the contact flow.

Constraints:
Length: - 500

Class com.amazonaws.services.connect.model.CreateHoursOfOperationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

config

java.util.List<HoursOfOperationConfig> config

Configuration information for the hours of operation: day, start time, and end time.

description

java.lang.String description

The description of the hours of operation.

Constraints:
Length: 1 - 250

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

name

java.lang.String name

The name of the hours of operation.

Constraints:
Length: 1 - 127

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

timeZone

java.lang.String timeZone

The time zone of the hours of operation.

Class com.amazonaws.services.connect.model.CreateHoursOfOperationResult extends java.lang.Object implements Serializable

Serialized Fields

hoursOfOperationArn

java.lang.String hoursOfOperationArn

The Amazon Resource Name (ARN) for the hours of operation.

hoursOfOperationId

java.lang.String hoursOfOperationId

The identifier for the hours of operation.

Class com.amazonaws.services.connect.model.CreateInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

The idempotency token.

Constraints:
Length: - 500

directoryId

java.lang.String directoryId

The identifier for the directory.

Constraints:
Length: 12 - 12
Pattern: ^d-[0-9a-f]{10}$

identityManagementType

java.lang.String identityManagementType

The type of identity management for your Amazon Connect users.

Constraints:
Allowed Values: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY

inboundCallsEnabled

java.lang.Boolean inboundCallsEnabled

Your contact center handles incoming contacts.

instanceAlias

java.lang.String instanceAlias

The name for your instance.

Constraints:
Length: 1 - 62
Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*$

outboundCallsEnabled

java.lang.Boolean outboundCallsEnabled

Your contact center allows outbound calls.

Class com.amazonaws.services.connect.model.CreateInstanceResult extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the instance.

id

java.lang.String id

The identifier for the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.CreateIntegrationAssociationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

integrationArn

java.lang.String integrationArn

The Amazon Resource Name (ARN) of the integration.

integrationType

java.lang.String integrationType

The type of information to be ingested.

Constraints:
Allowed Values: EVENT, VOICE_ID, PINPOINT_APP, WISDOM_ASSISTANT, WISDOM_KNOWLEDGE_BASE

sourceApplicationName

java.lang.String sourceApplicationName

The name of the external application. This field is only required for the EVENT integration type.

Constraints:
Length: 1 - 100
Pattern: ^[a-zA-Z0-9_ -]+$

sourceApplicationUrl

java.lang.String sourceApplicationUrl

The URL for the external application. This field is only required for the EVENT integration type.

Constraints:
Length: 1 - 2000

sourceType

java.lang.String sourceType

The type of the data source. This field is only required for the EVENT integration type.

Constraints:
Allowed Values: SALESFORCE, ZENDESK

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

Class com.amazonaws.services.connect.model.CreateIntegrationAssociationResult extends java.lang.Object implements Serializable

Serialized Fields

integrationAssociationArn

java.lang.String integrationAssociationArn

The Amazon Resource Name (ARN) for the association.

integrationAssociationId

java.lang.String integrationAssociationId

The identifier for the integration association.

Constraints:
Length: 1 - 200

Class com.amazonaws.services.connect.model.CreateQueueRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

The description of the queue.

Constraints:
Length: 1 - 250

hoursOfOperationId

java.lang.String hoursOfOperationId

The identifier for the hours of operation.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxContacts

java.lang.Integer maxContacts

The maximum number of contacts that can be in the queue before it is considered full.

Constraints:
Range: 0 -

name

java.lang.String name

The name of the queue.

Constraints:
Length: 1 - 127

outboundCallerConfig

OutboundCallerConfig outboundCallerConfig

The outbound caller ID name, number, and outbound whisper flow.

quickConnectIds

java.util.List<java.lang.String> quickConnectIds

The quick connects available to agents who are working the queue.

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

Class com.amazonaws.services.connect.model.CreateQueueResult extends java.lang.Object implements Serializable

Serialized Fields

queueArn

java.lang.String queueArn

The Amazon Resource Name (ARN) of the queue.

queueId

java.lang.String queueId

The identifier for the queue.

Class com.amazonaws.services.connect.model.CreateQuickConnectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

The description of the quick connect.

Constraints:
Length: 1 - 250

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

name

java.lang.String name

The name of the quick connect.

Constraints:
Length: 1 - 127

quickConnectConfig

QuickConnectConfig quickConnectConfig

Configuration settings for the quick connect.

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

Class com.amazonaws.services.connect.model.CreateQuickConnectResult extends java.lang.Object implements Serializable

Serialized Fields

quickConnectARN

java.lang.String quickConnectARN

The Amazon Resource Name (ARN) for the quick connect.

quickConnectId

java.lang.String quickConnectId

The identifier for the quick connect.

Class com.amazonaws.services.connect.model.CreateRoutingProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

defaultOutboundQueueId

java.lang.String defaultOutboundQueueId

The default outbound queue for the routing profile.

description

java.lang.String description

Description of the routing profile. Must not be more than 250 characters.

Constraints:
Length: 1 - 250

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

mediaConcurrencies

java.util.List<MediaConcurrency> mediaConcurrencies

The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.

name

java.lang.String name

The name of the routing profile. Must not be more than 127 characters.

Constraints:
Length: 1 - 127

queueConfigs

java.util.List<RoutingProfileQueueConfig> queueConfigs

The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.

tags

java.util.Map<java.lang.String,java.lang.String> tags

One or more tags.

Class com.amazonaws.services.connect.model.CreateRoutingProfileResult extends java.lang.Object implements Serializable

Serialized Fields

routingProfileArn

java.lang.String routingProfileArn

The Amazon Resource Name (ARN) of the routing profile.

routingProfileId

java.lang.String routingProfileId

The identifier of the routing profile.

Class com.amazonaws.services.connect.model.CreateSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

The description of the security profile.

Constraints:
Length: - 250

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

permissions

java.util.List<java.lang.String> permissions

Permissions assigned to the security profile.

securityProfileName

java.lang.String securityProfileName

The name of the security profile.

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

Class com.amazonaws.services.connect.model.CreateSecurityProfileResult extends java.lang.Object implements Serializable

Serialized Fields

securityProfileArn

java.lang.String securityProfileArn

The Amazon Resource Name (ARN) for the security profile.

securityProfileId

java.lang.String securityProfileId

The identifier for the security profle.

Class com.amazonaws.services.connect.model.CreateUseCaseRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

integrationAssociationId

java.lang.String integrationAssociationId

The identifier for the integration association.

Constraints:
Length: 1 - 200

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

useCaseType

java.lang.String useCaseType

The type of use case to associate to the integration association. Each integration association can have only one of each use case type.

Constraints:
Allowed Values: RULES_EVALUATION, CONNECT_CAMPAIGNS

Class com.amazonaws.services.connect.model.CreateUseCaseResult extends java.lang.Object implements Serializable

Serialized Fields

useCaseArn

java.lang.String useCaseArn

The Amazon Resource Name (ARN) for the use case.

useCaseId

java.lang.String useCaseId

The identifier of the use case.

Constraints:
Length: 1 - 200

Class com.amazonaws.services.connect.model.CreateUserHierarchyGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

name

java.lang.String name

The name of the user hierarchy group. Must not be more than 100 characters.

parentGroupId

java.lang.String parentGroupId

The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

Class com.amazonaws.services.connect.model.CreateUserHierarchyGroupResult extends java.lang.Object implements Serializable

Serialized Fields

hierarchyGroupArn

java.lang.String hierarchyGroupArn

The Amazon Resource Name (ARN) of the hierarchy group.

hierarchyGroupId

java.lang.String hierarchyGroupId

The identifier of the hierarchy group.

Class com.amazonaws.services.connect.model.CreateUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

directoryUserId

java.lang.String directoryUserId

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

hierarchyGroupId

java.lang.String hierarchyGroupId

The identifier of the hierarchy group for the user.

identityInfo

UserIdentityInfo identityInfo

The information about the identity of the user.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

password

java.lang.String password

The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

Constraints:
Pattern: /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d\S]{8,64}$/

phoneConfig

UserPhoneConfig phoneConfig

The phone settings for the user.

routingProfileId

java.lang.String routingProfileId

The identifier of the routing profile for the user.

securityProfileIds

java.util.List<java.lang.String> securityProfileIds

The identifier of the security profile for the user.

tags

java.util.Map<java.lang.String,java.lang.String> tags

One or more tags.

username

java.lang.String username

The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.CreateUserResult extends java.lang.Object implements Serializable

Serialized Fields

userArn

java.lang.String userArn

The Amazon Resource Name (ARN) of the user account.

userId

java.lang.String userId

The identifier of the user account.

Class com.amazonaws.services.connect.model.CreateVocabularyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.

Constraints:
Length: - 500

content

java.lang.String content

The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.

Constraints:
Length: 1 - 60000

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

languageCode

java.lang.String languageCode

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

Constraints:
Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

vocabularyName

java.lang.String vocabularyName

A unique name of the custom vocabulary.

Constraints:
Length: 1 - 140
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.connect.model.CreateVocabularyResult extends java.lang.Object implements Serializable

Serialized Fields

state

java.lang.String state

The current state of the custom vocabulary.

Constraints:
Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS

vocabularyArn

java.lang.String vocabularyArn

The Amazon Resource Name (ARN) of the custom vocabulary.

vocabularyId

java.lang.String vocabularyId

The identifier of the custom vocabulary.

Constraints:
Length: 1 - 500

Class com.amazonaws.services.connect.model.Credentials extends java.lang.Object implements Serializable

Serialized Fields

accessToken

java.lang.String accessToken

An access token generated for a federated user to access Amazon Connect.

accessTokenExpiration

java.util.Date accessTokenExpiration

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

refreshToken

java.lang.String refreshToken

Renews a token generated for a user to access the Amazon Connect instance.

refreshTokenExpiration

java.util.Date refreshTokenExpiration

Renews the expiration timer for a generated token.

Class com.amazonaws.services.connect.model.CurrentMetric extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the metric.

Constraints:
Allowed Values: AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE

unit

java.lang.String unit

The unit for the metric.

Constraints:
Allowed Values: SECONDS, COUNT, PERCENT

Class com.amazonaws.services.connect.model.CurrentMetricData extends java.lang.Object implements Serializable

Serialized Fields

metric

CurrentMetric metric

Information about the metric.

value

java.lang.Double value

The value of the metric.

Class com.amazonaws.services.connect.model.CurrentMetricResult extends java.lang.Object implements Serializable

Serialized Fields

collections

java.util.List<CurrentMetricData> collections

The set of metrics.

dimensions

Dimensions dimensions

The dimensions for the metrics.

Class com.amazonaws.services.connect.model.DefaultVocabulary extends java.lang.Object implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

languageCode

java.lang.String languageCode

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

Constraints:
Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN

vocabularyId

java.lang.String vocabularyId

The identifier of the custom vocabulary.

Constraints:
Length: 1 - 500

vocabularyName

java.lang.String vocabularyName

A unique name of the custom vocabulary.

Constraints:
Length: 1 - 140
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.connect.model.DeleteContactFlowModuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactFlowModuleId

java.lang.String contactFlowModuleId

The identifier of the contact flow module.

Constraints:
Length: 1 - 256

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.DeleteContactFlowModuleResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connect.model.DeleteContactFlowRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactFlowId

java.lang.String contactFlowId

The identifier of the contact flow.

Constraints:
Length: - 500

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.DeleteHoursOfOperationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

hoursOfOperationId

java.lang.String hoursOfOperationId

The identifier for the hours of operation.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.DeleteInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.DeleteIntegrationAssociationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

integrationAssociationId

java.lang.String integrationAssociationId

The identifier for the integration association.

Constraints:
Length: 1 - 200

Class com.amazonaws.services.connect.model.DeleteQuickConnectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

quickConnectId

java.lang.String quickConnectId

The identifier for the quick connect.

Class com.amazonaws.services.connect.model.DeleteSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

securityProfileId

java.lang.String securityProfileId

The identifier for the security profle.

Class com.amazonaws.services.connect.model.DeleteUseCaseRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

integrationAssociationId

java.lang.String integrationAssociationId

The identifier for the integration association.

Constraints:
Length: 1 - 200

useCaseId

java.lang.String useCaseId

The identifier for the use case.

Constraints:
Length: 1 - 200

Class com.amazonaws.services.connect.model.DeleteUserHierarchyGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

hierarchyGroupId

java.lang.String hierarchyGroupId

The identifier of the hierarchy group.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

userId

java.lang.String userId

The identifier of the user.

Class com.amazonaws.services.connect.model.DeleteVocabularyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

vocabularyId

java.lang.String vocabularyId

The identifier of the custom vocabulary.

Constraints:
Length: 1 - 500

Class com.amazonaws.services.connect.model.DeleteVocabularyResult extends java.lang.Object implements Serializable

Serialized Fields

state

java.lang.String state

The current state of the custom vocabulary.

Constraints:
Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS

vocabularyArn

java.lang.String vocabularyArn

The Amazon Resource Name (ARN) of the custom vocabulary.

vocabularyId

java.lang.String vocabularyId

The identifier of the custom vocabulary.

Constraints:
Length: 1 - 500

Class com.amazonaws.services.connect.model.DescribeAgentStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

agentStatusId

java.lang.String agentStatusId

The identifier for the agent status.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.DescribeAgentStatusResult extends java.lang.Object implements Serializable

Serialized Fields

agentStatus

AgentStatus agentStatus

The agent status.

Class com.amazonaws.services.connect.model.DescribeContactFlowModuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactFlowModuleId

java.lang.String contactFlowModuleId

The identifier of the contact flow module.

Constraints:
Length: 1 - 256

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.DescribeContactFlowModuleResult extends java.lang.Object implements Serializable

Serialized Fields

contactFlowModule

ContactFlowModule contactFlowModule

Information about the contact flow module.

Class com.amazonaws.services.connect.model.DescribeContactFlowRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactFlowId

java.lang.String contactFlowId

The identifier of the contact flow.

Constraints:
Length: - 500

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.DescribeContactFlowResult extends java.lang.Object implements Serializable

Serialized Fields

contactFlow

ContactFlow contactFlow

Information about the contact flow.

Class com.amazonaws.services.connect.model.DescribeContactRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactId

java.lang.String contactId

The identifier of the contact.

Constraints:
Length: 1 - 256

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.DescribeContactResult extends java.lang.Object implements Serializable

Serialized Fields

contact

Contact contact

Information about the contact.

Class com.amazonaws.services.connect.model.DescribeHoursOfOperationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

hoursOfOperationId

java.lang.String hoursOfOperationId

The identifier for the hours of operation.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.DescribeHoursOfOperationResult extends java.lang.Object implements Serializable

Serialized Fields

hoursOfOperation

HoursOfOperation hoursOfOperation

The hours of operation.

Class com.amazonaws.services.connect.model.DescribeInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeType

java.lang.String attributeType

The type of attribute.

Constraints:
Allowed Values: INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA, MULTI_PARTY_CONFERENCE

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.DescribeInstanceAttributeResult extends java.lang.Object implements Serializable

Serialized Fields

attribute

Attribute attribute

The type of attribute.

Class com.amazonaws.services.connect.model.DescribeInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.DescribeInstanceResult extends java.lang.Object implements Serializable

Serialized Fields

instance

Instance instance

The name of the instance.

Class com.amazonaws.services.connect.model.DescribeInstanceStorageConfigRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

associationId

java.lang.String associationId

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

Constraints:
Length: 1 - 100

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

resourceType

java.lang.String resourceType

A valid resource type.

Constraints:
Allowed Values: CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS

Class com.amazonaws.services.connect.model.DescribeInstanceStorageConfigResult extends java.lang.Object implements Serializable

Serialized Fields

storageConfig

InstanceStorageConfig storageConfig

A valid storage type.

Class com.amazonaws.services.connect.model.DescribePhoneNumberRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

phoneNumberId

java.lang.String phoneNumberId

A unique identifier for the phone number.

Class com.amazonaws.services.connect.model.DescribePhoneNumberResult extends java.lang.Object implements Serializable

Serialized Fields

claimedPhoneNumberSummary

ClaimedPhoneNumberSummary claimedPhoneNumberSummary

Information about a phone number that's been claimed to your Amazon Connect instance.

Class com.amazonaws.services.connect.model.DescribeQueueRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

queueId

java.lang.String queueId

The identifier for the queue.

Class com.amazonaws.services.connect.model.DescribeQueueResult extends java.lang.Object implements Serializable

Serialized Fields

queue

Queue queue

The name of the queue.

Class com.amazonaws.services.connect.model.DescribeQuickConnectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

quickConnectId

java.lang.String quickConnectId

The identifier for the quick connect.

Class com.amazonaws.services.connect.model.DescribeQuickConnectResult extends java.lang.Object implements Serializable

Serialized Fields

quickConnect

QuickConnect quickConnect

Information about the quick connect.

Class com.amazonaws.services.connect.model.DescribeRoutingProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

routingProfileId

java.lang.String routingProfileId

The identifier of the routing profile.

Class com.amazonaws.services.connect.model.DescribeRoutingProfileResult extends java.lang.Object implements Serializable

Serialized Fields

routingProfile

RoutingProfile routingProfile

The routing profile.

Class com.amazonaws.services.connect.model.DescribeSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

securityProfileId

java.lang.String securityProfileId

The identifier for the security profle.

Class com.amazonaws.services.connect.model.DescribeSecurityProfileResult extends java.lang.Object implements Serializable

Serialized Fields

securityProfile

SecurityProfile securityProfile

The security profile.

Class com.amazonaws.services.connect.model.DescribeUserHierarchyGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

hierarchyGroupId

java.lang.String hierarchyGroupId

The identifier of the hierarchy group.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.DescribeUserHierarchyGroupResult extends java.lang.Object implements Serializable

Serialized Fields

hierarchyGroup

HierarchyGroup hierarchyGroup

Information about the hierarchy group.

Class com.amazonaws.services.connect.model.DescribeUserHierarchyStructureRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.DescribeUserHierarchyStructureResult extends java.lang.Object implements Serializable

Serialized Fields

hierarchyStructure

HierarchyStructure hierarchyStructure

Information about the hierarchy structure.

Class com.amazonaws.services.connect.model.DescribeUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

userId

java.lang.String userId

The identifier of the user account.

Class com.amazonaws.services.connect.model.DescribeUserResult extends java.lang.Object implements Serializable

Serialized Fields

user

User user

Information about the user account and configuration settings.

Class com.amazonaws.services.connect.model.DescribeVocabularyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

vocabularyId

java.lang.String vocabularyId

The identifier of the custom vocabulary.

Constraints:
Length: 1 - 500

Class com.amazonaws.services.connect.model.DescribeVocabularyResult extends java.lang.Object implements Serializable

Serialized Fields

vocabulary

Vocabulary vocabulary

A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns.

Class com.amazonaws.services.connect.model.DestinationNotAllowedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connect.model.Dimensions extends java.lang.Object implements Serializable

Serialized Fields

channel

java.lang.String channel

The channel used for grouping and filters.

Constraints:
Allowed Values: VOICE, CHAT, TASK

queue

QueueReference queue

Information about the queue for which metrics are returned.

Class com.amazonaws.services.connect.model.DisassociateApprovedOriginRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

origin

java.lang.String origin

The domain URL of the integrated application.

Constraints:
Length: - 267

Class com.amazonaws.services.connect.model.DisassociateBotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

lexBot

LexBot lexBot

Configuration information of an Amazon Lex bot.

lexV2Bot

LexV2Bot lexV2Bot

The Amazon Lex V2 bot to disassociate from the instance.

Class com.amazonaws.services.connect.model.DisassociateInstanceStorageConfigRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

associationId

java.lang.String associationId

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

Constraints:
Length: 1 - 100

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

resourceType

java.lang.String resourceType

A valid resource type.

Constraints:
Allowed Values: CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS

Class com.amazonaws.services.connect.model.DisassociateLambdaFunctionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

functionArn

java.lang.String functionArn

The Amazon Resource Name (ARN) of the Lambda function being disassociated.

Constraints:
Length: 1 - 140

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance..

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.DisassociateLexBotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

botName

java.lang.String botName

The name of the Amazon Lex bot. Maximum character limit of 50.

Constraints:
Length: - 50

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

lexRegion

java.lang.String lexRegion

The Region in which the Amazon Lex bot has been created.

Constraints:
Length: - 60

Class com.amazonaws.services.connect.model.DisassociatePhoneNumberContactFlowRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

phoneNumberId

java.lang.String phoneNumberId

A unique identifier for the phone number.

Class com.amazonaws.services.connect.model.DisassociateQueueQuickConnectsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

queueId

java.lang.String queueId

The identifier for the queue.

quickConnectIds

java.util.List<java.lang.String> quickConnectIds

The quick connects to disassociate from the queue.

Class com.amazonaws.services.connect.model.DisassociateRoutingProfileQueuesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

queueReferences

java.util.List<RoutingProfileQueueReference> queueReferences

The queues to disassociate from this routing profile.

routingProfileId

java.lang.String routingProfileId

The identifier of the routing profile.

Class com.amazonaws.services.connect.model.DisassociateSecurityKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

associationId

java.lang.String associationId

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

Constraints:
Length: 1 - 100

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.DuplicateResourceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connect.model.EncryptionConfig extends java.lang.Object implements Serializable

Serialized Fields

encryptionType

java.lang.String encryptionType

The type of encryption.

Constraints:
Allowed Values: KMS

keyId

java.lang.String keyId

The full ARN of the encryption key.

Be sure to provide the full ARN of the encryption key, not just the ID.

Constraints:
Length: 1 - 128

Class com.amazonaws.services.connect.model.Filters extends java.lang.Object implements Serializable

Serialized Fields

channels

java.util.List<java.lang.String> channels

The channel to use to filter the metrics.

queues

java.util.List<java.lang.String> queues

The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The GetCurrentMetricsData API in particular requires a queue when you include a Filter in your request.

Class com.amazonaws.services.connect.model.GetContactAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

initialContactId

java.lang.String initialContactId

The identifier of the initial contact.

Constraints:
Length: 1 - 256

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.GetContactAttributesResult extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

Information about the attributes.

Class com.amazonaws.services.connect.model.GetCurrentMetricDataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

currentMetrics

java.util.List<CurrentMetric> currentMetrics

The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

AGENTS_AFTER_CONTACT_WORK

Unit: COUNT

Name in real-time metrics report: ACW

AGENTS_AVAILABLE

Unit: COUNT

Name in real-time metrics report: Available

AGENTS_ERROR

Unit: COUNT

Name in real-time metrics report: Error

AGENTS_NON_PRODUCTIVE

Unit: COUNT

Name in real-time metrics report: NPT (Non-Productive Time)

AGENTS_ON_CALL

Unit: COUNT

Name in real-time metrics report: On contact

AGENTS_ON_CONTACT

Unit: COUNT

Name in real-time metrics report: On contact

AGENTS_ONLINE

Unit: COUNT

Name in real-time metrics report: Online

AGENTS_STAFFED

Unit: COUNT

Name in real-time metrics report: Staffed

CONTACTS_IN_QUEUE

Unit: COUNT

Name in real-time metrics report: In queue

CONTACTS_SCHEDULED

Unit: COUNT

Name in real-time metrics report: Scheduled

OLDEST_CONTACT_AGE

Unit: SECONDS

When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.

When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:

{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0

The actual OLDEST_CONTACT_AGE is 24 seconds.

Name in real-time metrics report: Oldest

SLOTS_ACTIVE

Unit: COUNT

Name in real-time metrics report: Active

SLOTS_AVAILABLE

Unit: COUNT

Name in real-time metrics report: Availability

filters

Filters filters

The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.

groupings

java.util.List<java.lang.String> groupings

The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.

If no Grouping is included in the request, a summary of metrics is returned.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

Class com.amazonaws.services.connect.model.GetCurrentMetricDataResult extends java.lang.Object implements Serializable

Serialized Fields

dataSnapshotTime

java.util.Date dataSnapshotTime

The time at which the metrics were retrieved and cached for pagination.

metricResults

java.util.List<CurrentMetricResult> metricResults

Information about the real-time metrics.

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

Class com.amazonaws.services.connect.model.GetFederationTokenRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.GetFederationTokenResult extends java.lang.Object implements Serializable

Serialized Fields

credentials

Credentials credentials

The credentials to use for federation.

Class com.amazonaws.services.connect.model.GetMetricDataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endTime

java.util.Date endTime

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

The time range between the start and end time must be less than 24 hours.

filters

Filters filters

The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.

To filter by Queues, enter the queue ID/ARN, not the name of the queue.

groupings

java.util.List<java.lang.String> groupings

The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

If no grouping is specified, a summary of metrics for all queues is returned.

historicalMetrics

java.util.List<HistoricalMetric> historicalMetrics

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

ABANDON_TIME

Unit: SECONDS

Statistic: AVG

AFTER_CONTACT_WORK_TIME

Unit: SECONDS

Statistic: AVG

API_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_ABANDONED

Unit: COUNT

Statistic: SUM

CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNT

Statistic: SUM

CONTACTS_CONSULTED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_INCOMING

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_OUTBOUND

Unit: COUNT

Statistic: SUM

CONTACTS_HOLD_ABANDONS

Unit: COUNT

Statistic: SUM

CONTACTS_MISSED

Unit: COUNT

Statistic: SUM

CONTACTS_QUEUED

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNT

Statistic: SUM

HANDLE_TIME

Unit: SECONDS

Statistic: AVG

HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_AND_HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_TIME

Unit: SECONDS

Statistic: AVG

OCCUPANCY

Unit: PERCENT

Statistic: AVG

QUEUE_ANSWER_TIME

Unit: SECONDS

Statistic: AVG

QUEUED_TIME

Unit: SECONDS

Statistic: MAX

SERVICE_LEVEL

You can include up to 20 SERVICE_LEVEL metrics in a request.

Unit: PERCENT

Statistic: AVG

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

startTime

java.util.Date startTime

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

Class com.amazonaws.services.connect.model.GetMetricDataResult extends java.lang.Object implements Serializable

Serialized Fields

metricResults

java.util.List<HistoricalMetricResult> metricResults

Information about the historical metrics.

If no grouping is specified, a summary of metric data is returned.

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

Class com.amazonaws.services.connect.model.HierarchyGroup extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the hierarchy group.

hierarchyPath

HierarchyPath hierarchyPath

Information about the levels in the hierarchy group.

id

java.lang.String id

The identifier of the hierarchy group.

levelId

java.lang.String levelId

The identifier of the level in the hierarchy group.

name

java.lang.String name

The name of the hierarchy group.

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

Class com.amazonaws.services.connect.model.HierarchyGroupCondition extends java.lang.Object implements Serializable

Serialized Fields

hierarchyGroupMatchType

java.lang.String hierarchyGroupMatchType

The type of hierarchy group match.

Constraints:
Allowed Values: EXACT, WITH_CHILD_GROUPS

value

java.lang.String value

The value in the hierarchy group condition.

Class com.amazonaws.services.connect.model.HierarchyGroupSummary extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the hierarchy group.

id

java.lang.String id

The identifier of the hierarchy group.

name

java.lang.String name

The name of the hierarchy group.

Class com.amazonaws.services.connect.model.HierarchyLevel extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the hierarchy level.

id

java.lang.String id

The identifier of the hierarchy level.

name

java.lang.String name

The name of the hierarchy level.

Class com.amazonaws.services.connect.model.HierarchyLevelUpdate extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the user hierarchy level. Must not be more than 50 characters.

Class com.amazonaws.services.connect.model.HierarchyPath extends java.lang.Object implements Serializable

Serialized Fields

levelFive

HierarchyGroupSummary levelFive

Information about level five.

levelFour

HierarchyGroupSummary levelFour

Information about level four.

levelOne

HierarchyGroupSummary levelOne

Information about level one.

levelThree

HierarchyGroupSummary levelThree

Information about level three.

levelTwo

HierarchyGroupSummary levelTwo

Information about level two.

Class com.amazonaws.services.connect.model.HierarchyStructure extends java.lang.Object implements Serializable

Serialized Fields

levelFive

HierarchyLevel levelFive

Information about level five.

levelFour

HierarchyLevel levelFour

Information about level four.

levelOne

HierarchyLevel levelOne

Information about level one.

levelThree

HierarchyLevel levelThree

Information about level three.

levelTwo

HierarchyLevel levelTwo

Information about level two.

Class com.amazonaws.services.connect.model.HierarchyStructureUpdate extends java.lang.Object implements Serializable

Serialized Fields

levelFive

HierarchyLevelUpdate levelFive

The update for level five.

levelFour

HierarchyLevelUpdate levelFour

The update for level four.

levelOne

HierarchyLevelUpdate levelOne

The update for level one.

levelThree

HierarchyLevelUpdate levelThree

The update for level three.

levelTwo

HierarchyLevelUpdate levelTwo

The update for level two.

Class com.amazonaws.services.connect.model.HistoricalMetric extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the metric.

Constraints:
Allowed Values: CONTACTS_QUEUED, CONTACTS_HANDLED, CONTACTS_ABANDONED, CONTACTS_CONSULTED, CONTACTS_AGENT_HUNG_UP_FIRST, CONTACTS_HANDLED_INCOMING, CONTACTS_HANDLED_OUTBOUND, CONTACTS_HOLD_ABANDONS, CONTACTS_TRANSFERRED_IN, CONTACTS_TRANSFERRED_OUT, CONTACTS_TRANSFERRED_IN_FROM_QUEUE, CONTACTS_TRANSFERRED_OUT_FROM_QUEUE, CONTACTS_MISSED, CALLBACK_CONTACTS_HANDLED, API_CONTACTS_HANDLED, OCCUPANCY, HANDLE_TIME, AFTER_CONTACT_WORK_TIME, QUEUED_TIME, ABANDON_TIME, QUEUE_ANSWER_TIME, HOLD_TIME, INTERACTION_TIME, INTERACTION_AND_HOLD_TIME, SERVICE_LEVEL

statistic

java.lang.String statistic

The statistic for the metric.

Constraints:
Allowed Values: SUM, MAX, AVG

threshold

Threshold threshold

The threshold for the metric, used with service level metrics.

unit

java.lang.String unit

The unit for the metric.

Constraints:
Allowed Values: SECONDS, COUNT, PERCENT

Class com.amazonaws.services.connect.model.HistoricalMetricData extends java.lang.Object implements Serializable

Serialized Fields

metric

HistoricalMetric metric

Information about the metric.

value

java.lang.Double value

The value of the metric.

Class com.amazonaws.services.connect.model.HistoricalMetricResult extends java.lang.Object implements Serializable

Serialized Fields

collections

java.util.List<HistoricalMetricData> collections

The set of metrics.

dimensions

Dimensions dimensions

The dimension for the metrics.

Class com.amazonaws.services.connect.model.HoursOfOperation extends java.lang.Object implements Serializable

Serialized Fields

config

java.util.List<HoursOfOperationConfig> config

Configuration information for the hours of operation.

description

java.lang.String description

The description for the hours of operation.

Constraints:
Length: 1 - 250

hoursOfOperationArn

java.lang.String hoursOfOperationArn

The Amazon Resource Name (ARN) for the hours of operation.

hoursOfOperationId

java.lang.String hoursOfOperationId

The identifier for the hours of operation.

name

java.lang.String name

The name for the hours of operation.

Constraints:
Length: 1 - 127

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

timeZone

java.lang.String timeZone

The time zone for the hours of operation.

Class com.amazonaws.services.connect.model.HoursOfOperationConfig extends java.lang.Object implements Serializable

Serialized Fields

day

java.lang.String day

The day that the hours of operation applies to.

Constraints:
Allowed Values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY

endTime

HoursOfOperationTimeSlice endTime

The end time that your contact center closes.

startTime

HoursOfOperationTimeSlice startTime

The start time that your contact center opens.

Class com.amazonaws.services.connect.model.HoursOfOperationSummary extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the hours of operation.

id

java.lang.String id

The identifier of the hours of operation.

name

java.lang.String name

The name of the hours of operation.

Class com.amazonaws.services.connect.model.HoursOfOperationTimeSlice extends java.lang.Object implements Serializable

Serialized Fields

hours

java.lang.Integer hours

The hours.

Constraints:
Range: 0 - 23

minutes

java.lang.Integer minutes

The minutes.

Constraints:
Range: 0 - 59

Class com.amazonaws.services.connect.model.IdempotencyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connect.model.Instance extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the instance.

createdTime

java.util.Date createdTime

When the instance was created.

id

java.lang.String id

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

identityManagementType

java.lang.String identityManagementType

The identity management type.

Constraints:
Allowed Values: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY

inboundCallsEnabled

java.lang.Boolean inboundCallsEnabled

Whether inbound calls are enabled.

instanceAlias

java.lang.String instanceAlias

The alias of instance.

Constraints:
Length: 1 - 62
Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*$

instanceStatus

java.lang.String instanceStatus

The state of the instance.

Constraints:
Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED

outboundCallsEnabled

java.lang.Boolean outboundCallsEnabled

Whether outbound calls are enabled.

serviceRole

java.lang.String serviceRole

The service role of the instance.

statusReason

InstanceStatusReason statusReason

Relevant details why the instance was not successfully created.

Class com.amazonaws.services.connect.model.InstanceStatusReason extends java.lang.Object implements Serializable

Serialized Fields

message

java.lang.String message

The message.

Class com.amazonaws.services.connect.model.InstanceStorageConfig extends java.lang.Object implements Serializable

Serialized Fields

associationId

java.lang.String associationId

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

Constraints:
Length: 1 - 100

kinesisFirehoseConfig

KinesisFirehoseConfig kinesisFirehoseConfig

The configuration of the Kinesis Firehose delivery stream.

kinesisStreamConfig

KinesisStreamConfig kinesisStreamConfig

The configuration of the Kinesis data stream.

kinesisVideoStreamConfig

KinesisVideoStreamConfig kinesisVideoStreamConfig

The configuration of the Kinesis video stream.

s3Config

S3Config s3Config

The S3 bucket configuration.

storageType

java.lang.String storageType

A valid storage type.

Constraints:
Allowed Values: S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE

Class com.amazonaws.services.connect.model.InstanceSummary extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the instance.

createdTime

java.util.Date createdTime

When the instance was created.

id

java.lang.String id

The identifier of the instance.

Constraints:
Length: 1 - 100

identityManagementType

java.lang.String identityManagementType

The identity management type of the instance.

Constraints:
Allowed Values: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY

inboundCallsEnabled

java.lang.Boolean inboundCallsEnabled

Whether inbound calls are enabled.

instanceAlias

java.lang.String instanceAlias

The alias of the instance.

Constraints:
Length: 1 - 62
Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*$

instanceStatus

java.lang.String instanceStatus

The state of the instance.

Constraints:
Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED

outboundCallsEnabled

java.lang.Boolean outboundCallsEnabled

Whether outbound calls are enabled.

serviceRole

java.lang.String serviceRole

The service role of the instance.

Class com.amazonaws.services.connect.model.IntegrationAssociationSummary extends java.lang.Object implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

integrationArn

java.lang.String integrationArn

The Amazon Resource Name (ARN) for the AppIntegration.

integrationAssociationArn

java.lang.String integrationAssociationArn

The Amazon Resource Name (ARN) for the AppIntegration association.

integrationAssociationId

java.lang.String integrationAssociationId

The identifier for the AppIntegration association.

Constraints:
Length: 1 - 200

integrationType

java.lang.String integrationType

The integration type.

Constraints:
Allowed Values: EVENT, VOICE_ID, PINPOINT_APP, WISDOM_ASSISTANT, WISDOM_KNOWLEDGE_BASE

sourceApplicationName

java.lang.String sourceApplicationName

The user-provided, friendly name for the external application.

Constraints:
Length: 1 - 100
Pattern: ^[a-zA-Z0-9_ -]+$

sourceApplicationUrl

java.lang.String sourceApplicationUrl

The URL for the external application.

Constraints:
Length: 1 - 2000

sourceType

java.lang.String sourceType

The name of the source.

Constraints:
Allowed Values: SALESFORCE, ZENDESK

Class com.amazonaws.services.connect.model.InternalServiceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connect.model.InvalidContactFlowException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

problems

java.util.List<ProblemDetail> problems

The problems with the contact flow. Please fix before trying again.

Class com.amazonaws.services.connect.model.InvalidContactFlowModuleException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

problems

java.util.List<ProblemDetail> problems

Class com.amazonaws.services.connect.model.InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connect.model.InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connect.model.KinesisFirehoseConfig extends java.lang.Object implements Serializable

Serialized Fields

firehoseArn

java.lang.String firehoseArn

The Amazon Resource Name (ARN) of the delivery stream.

Class com.amazonaws.services.connect.model.KinesisStreamConfig extends java.lang.Object implements Serializable

Serialized Fields

streamArn

java.lang.String streamArn

The Amazon Resource Name (ARN) of the data stream.

Class com.amazonaws.services.connect.model.KinesisVideoStreamConfig extends java.lang.Object implements Serializable

Serialized Fields

encryptionConfig

EncryptionConfig encryptionConfig

The encryption configuration.

prefix

java.lang.String prefix

The prefix of the video stream.

Constraints:
Length: 1 - 128

retentionPeriodHours

java.lang.Integer retentionPeriodHours

The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

Constraints:
Range: 0 - 87600

Class com.amazonaws.services.connect.model.LexBot extends java.lang.Object implements Serializable

Serialized Fields

lexRegion

java.lang.String lexRegion

The Region that the Amazon Lex bot was created in.

Constraints:
Length: - 60

name

java.lang.String name

The name of the Amazon Lex bot.

Constraints:
Length: - 50

Class com.amazonaws.services.connect.model.LexBotConfig extends java.lang.Object implements Serializable

Serialized Fields

lexBot

LexBot lexBot

Configuration information of an Amazon Lex bot.

lexV2Bot

LexV2Bot lexV2Bot

Configuration information of an Amazon Lex V2 bot.

Class com.amazonaws.services.connect.model.LexV2Bot extends java.lang.Object implements Serializable

Serialized Fields

aliasArn

java.lang.String aliasArn

The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connect.model.ListAgentStatusesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

agentStatusTypes

java.util.List<java.lang.String> agentStatusTypes

Available agent status types.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 1000

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListAgentStatusesResult extends java.lang.Object implements Serializable

Serialized Fields

agentStatusSummaryList

java.util.List<AgentStatusSummary> agentStatusSummaryList

A summary of agent statuses.

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

Class com.amazonaws.services.connect.model.ListApprovedOriginsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 25

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListApprovedOriginsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

origins

java.util.List<java.lang.String> origins

The approved origins.

Class com.amazonaws.services.connect.model.ListBotsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

lexVersion

java.lang.String lexVersion

The version of Amazon Lex or Amazon Lex V2.

Constraints:
Allowed Values: V1, V2

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 25

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListBotsResult extends java.lang.Object implements Serializable

Serialized Fields

lexBots

java.util.List<LexBotConfig> lexBots

The names and Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

Class com.amazonaws.services.connect.model.ListContactFlowModulesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactFlowModuleState

java.lang.String contactFlowModuleState

The state of the contact flow module.

Constraints:
Allowed Values: ACTIVE, ARCHIVED

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 1000

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListContactFlowModulesResult extends java.lang.Object implements Serializable

Serialized Fields

contactFlowModulesSummaryList

java.util.List<ContactFlowModuleSummary> contactFlowModulesSummaryList

Information about the contact flow module.

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

Class com.amazonaws.services.connect.model.ListContactFlowsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactFlowTypes

java.util.List<java.lang.String> contactFlowTypes

The type of contact flow.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 1000

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListContactFlowsResult extends java.lang.Object implements Serializable

Serialized Fields

contactFlowSummaryList

java.util.List<ContactFlowSummary> contactFlowSummaryList

Information about the contact flows.

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

Class com.amazonaws.services.connect.model.ListContactReferencesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactId

java.lang.String contactId

The identifier of the initial contact.

Constraints:
Length: 1 - 256

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

This is not expected to be set, because the value returned in the previous response is always null.

referenceTypes

java.util.List<java.lang.String> referenceTypes

The type of reference.

Class com.amazonaws.services.connect.model.ListContactReferencesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

This is always returned as null in the response.

referenceSummaryList

java.util.List<ReferenceSummary> referenceSummaryList

Information about the contact flows.

Class com.amazonaws.services.connect.model.ListDefaultVocabulariesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

languageCode

java.lang.String languageCode

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

Constraints:
Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Constraints:
Length: 1 - 131070
Pattern: .*\S.*

Class com.amazonaws.services.connect.model.ListDefaultVocabulariesResult extends java.lang.Object implements Serializable

Serialized Fields

defaultVocabularyList

java.util.List<DefaultVocabulary> defaultVocabularyList

A list of default vocabularies.

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

Constraints:
Length: 1 - 131070
Pattern: .*\S.*

Class com.amazonaws.services.connect.model.ListHoursOfOperationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 1000

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListHoursOfOperationsResult extends java.lang.Object implements Serializable

Serialized Fields

hoursOfOperationSummaryList

java.util.List<HoursOfOperationSummary> hoursOfOperationSummaryList

Information about the hours of operation.

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

Class com.amazonaws.services.connect.model.ListInstanceAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 7

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListInstanceAttributesResult extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.List<Attribute> attributes

The attribute types.

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

Class com.amazonaws.services.connect.model.ListInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 10

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListInstancesResult extends java.lang.Object implements Serializable

Serialized Fields

instanceSummaryList

java.util.List<InstanceSummary> instanceSummaryList

Information about the instances.

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

Class com.amazonaws.services.connect.model.ListInstanceStorageConfigsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 10

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

resourceType

java.lang.String resourceType

A valid resource type.

Constraints:
Allowed Values: CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS

Class com.amazonaws.services.connect.model.ListInstanceStorageConfigsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

storageConfigs

java.util.List<InstanceStorageConfig> storageConfigs

A valid storage type.

Class com.amazonaws.services.connect.model.ListIntegrationAssociationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

integrationType

java.lang.String integrationType

The integration type.

Constraints:
Allowed Values: EVENT, VOICE_ID, PINPOINT_APP, WISDOM_ASSISTANT, WISDOM_KNOWLEDGE_BASE

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListIntegrationAssociationsResult extends java.lang.Object implements Serializable

Serialized Fields

integrationAssociationSummaryList

java.util.List<IntegrationAssociationSummary> integrationAssociationSummaryList

The associations.

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

Class com.amazonaws.services.connect.model.ListLambdaFunctionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 25

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListLambdaFunctionsResult extends java.lang.Object implements Serializable

Serialized Fields

lambdaFunctions

java.util.List<java.lang.String> lambdaFunctions

The Lambdafunction ARNs associated with the specified instance.

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

Class com.amazonaws.services.connect.model.ListLexBotsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page. If no value is specified, the default is 10.

Constraints:
Range: 1 - 25

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListLexBotsResult extends java.lang.Object implements Serializable

Serialized Fields

lexBots

java.util.List<LexBot> lexBots

The names and Regions of the Amazon Lex bots associated with the specified instance.

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

Class com.amazonaws.services.connect.model.ListPhoneNumbersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 1000

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

phoneNumberCountryCodes

java.util.List<java.lang.String> phoneNumberCountryCodes

The ISO country code.

phoneNumberTypes

java.util.List<java.lang.String> phoneNumberTypes

The type of phone number.

Class com.amazonaws.services.connect.model.ListPhoneNumbersResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

phoneNumberSummaryList

java.util.List<PhoneNumberSummary> phoneNumberSummaryList

Information about the phone numbers.

Class com.amazonaws.services.connect.model.ListPhoneNumbersSummary extends java.lang.Object implements Serializable

Serialized Fields

phoneNumber

java.lang.String phoneNumber

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

Constraints:
Pattern: \\+[1-9]\\d{1,14}$

phoneNumberArn

java.lang.String phoneNumberArn

The Amazon Resource Name (ARN) of the phone number.

phoneNumberCountryCode

java.lang.String phoneNumberCountryCode

The ISO country code.

Constraints:
Allowed Values: AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW

phoneNumberId

java.lang.String phoneNumberId

A unique identifier for the phone number.

phoneNumberType

java.lang.String phoneNumberType

The type of phone number.

Constraints:
Allowed Values: TOLL_FREE, DID

targetArn

java.lang.String targetArn

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

Class com.amazonaws.services.connect.model.ListPhoneNumbersV2Request extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 1000

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Constraints:
Length: 1 - 100000

phoneNumberCountryCodes

java.util.List<java.lang.String> phoneNumberCountryCodes

The ISO country code.

phoneNumberPrefix

java.lang.String phoneNumberPrefix

The prefix of the phone number. If provided, it must contain + as part of the country code.

Constraints:
Pattern: \\+?[0-9]{1,11}

phoneNumberTypes

java.util.List<java.lang.String> phoneNumberTypes

The type of phone number.

targetArn

java.lang.String targetArn

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account.

Class com.amazonaws.services.connect.model.ListPhoneNumbersV2Result extends java.lang.Object implements Serializable

Serialized Fields

listPhoneNumbersSummaryList

java.util.List<ListPhoneNumbersSummary> listPhoneNumbersSummaryList

Information about phone numbers that have been claimed to your Amazon Connect instances.

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

Constraints:
Length: 1 - 100000

Class com.amazonaws.services.connect.model.ListPromptsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 1000

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListPromptsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

promptSummaryList

java.util.List<PromptSummary> promptSummaryList

Information about the prompts.

Class com.amazonaws.services.connect.model.ListQueueQuickConnectsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

queueId

java.lang.String queueId

The identifier for the queue.

Class com.amazonaws.services.connect.model.ListQueueQuickConnectsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

quickConnectSummaryList

java.util.List<QuickConnectSummary> quickConnectSummaryList

Information about the quick connects.

Class com.amazonaws.services.connect.model.ListQueuesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 1000

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

queueTypes

java.util.List<java.lang.String> queueTypes

The type of queue.

Class com.amazonaws.services.connect.model.ListQueuesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

queueSummaryList

java.util.List<QueueSummary> queueSummaryList

Information about the queues.

Class com.amazonaws.services.connect.model.ListQuickConnectsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 1000

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

quickConnectTypes

java.util.List<java.lang.String> quickConnectTypes

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

Class com.amazonaws.services.connect.model.ListQuickConnectsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

quickConnectSummaryList

java.util.List<QuickConnectSummary> quickConnectSummaryList

Information about the quick connects.

Class com.amazonaws.services.connect.model.ListRoutingProfileQueuesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

routingProfileId

java.lang.String routingProfileId

The identifier of the routing profile.

Class com.amazonaws.services.connect.model.ListRoutingProfileQueuesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

routingProfileQueueConfigSummaryList

java.util.List<RoutingProfileQueueConfigSummary> routingProfileQueueConfigSummaryList

Information about the routing profiles.

Class com.amazonaws.services.connect.model.ListRoutingProfilesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 1000

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListRoutingProfilesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

routingProfileSummaryList

java.util.List<RoutingProfileSummary> routingProfileSummaryList

Information about the routing profiles.

Class com.amazonaws.services.connect.model.ListSecurityKeysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 2

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListSecurityKeysResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

securityKeys

java.util.List<SecurityKey> securityKeys

The security keys.

Class com.amazonaws.services.connect.model.ListSecurityProfilePermissionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 1000

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

securityProfileId

java.lang.String securityProfileId

The identifier for the security profle.

Class com.amazonaws.services.connect.model.ListSecurityProfilePermissionsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

permissions

java.util.List<java.lang.String> permissions

The permissions granted to the security profile.

Class com.amazonaws.services.connect.model.ListSecurityProfilesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 1000

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListSecurityProfilesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

securityProfileSummaryList

java.util.List<SecurityProfileSummary> securityProfileSummaryList

Information about the security profiles.

Class com.amazonaws.services.connect.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the resource.

Class com.amazonaws.services.connect.model.ListTagsForResourceResult extends java.lang.Object implements Serializable

Serialized Fields

tags

java.util.Map<java.lang.String,java.lang.String> tags

Information about the tags.

Class com.amazonaws.services.connect.model.ListUseCasesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

integrationAssociationId

java.lang.String integrationAssociationId

The identifier for the integration association.

Constraints:
Length: 1 - 200

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListUseCasesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

useCaseSummaryList

java.util.List<UseCase> useCaseSummaryList

The use cases.

Class com.amazonaws.services.connect.model.ListUserHierarchyGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 1000

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListUserHierarchyGroupsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

userHierarchyGroupSummaryList

java.util.List<HierarchyGroupSummary> userHierarchyGroupSummaryList

Information about the hierarchy groups.

Class com.amazonaws.services.connect.model.ListUsersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 1000

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Class com.amazonaws.services.connect.model.ListUsersResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

userSummaryList

java.util.List<UserSummary> userSummaryList

Information about the users.

Class com.amazonaws.services.connect.model.MediaConcurrency extends java.lang.Object implements Serializable

Serialized Fields

channel

java.lang.String channel

The channels that agents can handle in the Contact Control Panel (CCP).

Constraints:
Allowed Values: VOICE, CHAT, TASK

concurrency

java.lang.Integer concurrency

The number of contacts an agent can have on a channel simultaneously.

Valid Range for VOICE: Minimum value of 1. Maximum value of 1.

Valid Range for CHAT: Minimum value of 1. Maximum value of 10.

Valid Range for TASK: Minimum value of 1. Maximum value of 10.

Constraints:
Range: 1 - 10

Class com.amazonaws.services.connect.model.OutboundCallerConfig extends java.lang.Object implements Serializable

Serialized Fields

outboundCallerIdName

java.lang.String outboundCallerIdName

The caller ID name.

Constraints:
Length: 1 - 255

outboundCallerIdNumberId

java.lang.String outboundCallerIdNumberId

The caller ID number.

outboundFlowId

java.lang.String outboundFlowId

The outbound whisper flow to be used during an outbound call.

Constraints:
Length: - 500

Class com.amazonaws.services.connect.model.OutboundContactNotPermittedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connect.model.ParticipantDetails extends java.lang.Object implements Serializable

Serialized Fields

displayName

java.lang.String displayName

Display name of the participant.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.connect.model.PhoneNumberQuickConnectConfig extends java.lang.Object implements Serializable

Serialized Fields

phoneNumber

java.lang.String phoneNumber

The phone number in E.164 format.

Constraints:
Pattern: \\+[1-9]\\d{1,14}$

Class com.amazonaws.services.connect.model.PhoneNumberStatus extends java.lang.Object implements Serializable

Serialized Fields

message

java.lang.String message

The status message.

Constraints:
Length: 0 - 255
Pattern: ^[\W\S_]*

status

java.lang.String status

The status.

Constraints:
Allowed Values: CLAIMED, IN_PROGRESS, FAILED

Class com.amazonaws.services.connect.model.PhoneNumberSummary extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the phone number.

id

java.lang.String id

The identifier of the phone number.

phoneNumber

java.lang.String phoneNumber

The phone number.

Constraints:
Pattern: \\+[1-9]\\d{1,14}$

phoneNumberCountryCode

java.lang.String phoneNumberCountryCode

The ISO country code.

Constraints:
Allowed Values: AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW

phoneNumberType

java.lang.String phoneNumberType

The type of phone number.

Constraints:
Allowed Values: TOLL_FREE, DID

Class com.amazonaws.services.connect.model.ProblemDetail extends java.lang.Object implements Serializable

Serialized Fields

message

java.lang.String message

The problem detail's message.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.connect.model.PromptSummary extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the prompt.

id

java.lang.String id

The identifier of the prompt.

Constraints:
Length: 1 - 256

name

java.lang.String name

The name of the prompt.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.connect.model.PutUserStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

agentStatusId

java.lang.String agentStatusId

The identifier of the agent status.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

userId

java.lang.String userId

The identifier of the user.

Class com.amazonaws.services.connect.model.PutUserStatusResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connect.model.Queue extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

The description of the queue.

Constraints:
Length: 1 - 250

hoursOfOperationId

java.lang.String hoursOfOperationId

The identifier for the hours of operation.

maxContacts

java.lang.Integer maxContacts

The maximum number of contacts that can be in the queue before it is considered full.

Constraints:
Range: 0 -

name

java.lang.String name

The name of the queue.

Constraints:
Length: 1 - 127

outboundCallerConfig

OutboundCallerConfig outboundCallerConfig

The outbound caller ID name, number, and outbound whisper flow.

queueArn

java.lang.String queueArn

The Amazon Resource Name (ARN) for the queue.

queueId

java.lang.String queueId

The identifier for the queue.

status

java.lang.String status

The status of the queue.

Constraints:
Allowed Values: ENABLED, DISABLED

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

Class com.amazonaws.services.connect.model.QueueInfo extends java.lang.Object implements Serializable

Serialized Fields

enqueueTimestamp

java.util.Date enqueueTimestamp

The timestamp when the contact was added to the queue.

id

java.lang.String id

The identifier of the agent who accepted the contact.

Class com.amazonaws.services.connect.model.QueueQuickConnectConfig extends java.lang.Object implements Serializable

Serialized Fields

contactFlowId

java.lang.String contactFlowId

The identifier of the contact flow.

Constraints:
Length: - 500

queueId

java.lang.String queueId

The identifier for the queue.

Class com.amazonaws.services.connect.model.QueueReference extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the queue.

id

java.lang.String id

The identifier of the queue.

Class com.amazonaws.services.connect.model.QueueSummary extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the queue.

id

java.lang.String id

The identifier of the queue.

name

java.lang.String name

The name of the queue.

Constraints:
Length: 1 - 256

queueType

java.lang.String queueType

The type of queue.

Constraints:
Allowed Values: STANDARD, AGENT

Class com.amazonaws.services.connect.model.QuickConnect extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

The description.

Constraints:
Length: 1 - 250

name

java.lang.String name

The name of the quick connect.

Constraints:
Length: 1 - 127

quickConnectARN

java.lang.String quickConnectARN

The Amazon Resource Name (ARN) of the quick connect.

quickConnectConfig

QuickConnectConfig quickConnectConfig

Contains information about the quick connect.

quickConnectId

java.lang.String quickConnectId

The identifier for the quick connect.

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

Class com.amazonaws.services.connect.model.QuickConnectConfig extends java.lang.Object implements Serializable

Serialized Fields

phoneConfig

PhoneNumberQuickConnectConfig phoneConfig

The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.

queueConfig

QueueQuickConnectConfig queueConfig

The queue configuration. This is required only if QuickConnectType is QUEUE.

quickConnectType

java.lang.String quickConnectType

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

Constraints:
Allowed Values: USER, QUEUE, PHONE_NUMBER

userConfig

UserQuickConnectConfig userConfig

The user configuration. This is required only if QuickConnectType is USER.

Class com.amazonaws.services.connect.model.QuickConnectSummary extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the quick connect.

id

java.lang.String id

The identifier for the quick connect.

name

java.lang.String name

The name of the quick connect.

Constraints:
Length: 1 - 127

quickConnectType

java.lang.String quickConnectType

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

Constraints:
Allowed Values: USER, QUEUE, PHONE_NUMBER

Class com.amazonaws.services.connect.model.Reference extends java.lang.Object implements Serializable

Serialized Fields

type

java.lang.String type

The type of the reference. Only URL type can be added or updated on a contact.

Constraints:
Allowed Values: URL, ATTACHMENT

value

java.lang.String value

A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

Constraints:
Length: 0 - 4096

Class com.amazonaws.services.connect.model.ReferenceSummary extends java.lang.Object implements Serializable

Serialized Fields

attachment

AttachmentReference attachment

Information about the attachment reference if the referenceType is ATTACHMENT. Otherwise, null.

url

UrlReference url

Information about the URL reference if the referenceType is URL. Otherwise, null.

Class com.amazonaws.services.connect.model.ReleasePhoneNumberRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:
Length: - 500

phoneNumberId

java.lang.String phoneNumberId

A unique identifier for the phone number.

Class com.amazonaws.services.connect.model.ResourceConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connect.model.ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

resourceId

java.lang.String resourceId

The identifier for the resource.

resourceType

java.lang.String resourceType

The type of resource.

Constraints:
Allowed Values: CONTACT, CONTACT_FLOW, INSTANCE, PARTICIPANT, HIERARCHY_LEVEL, HIERARCHY_GROUP, USER

Class com.amazonaws.services.connect.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connect.model.ResumeContactRecordingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactId

java.lang.String contactId

The identifier of the contact.

Constraints:
Length: 1 - 256

initialContactId

java.lang.String initialContactId

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

Constraints:
Length: 1 - 256

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.ResumeContactRecordingResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connect.model.RoutingProfile extends java.lang.Object implements Serializable

Serialized Fields

defaultOutboundQueueId

java.lang.String defaultOutboundQueueId

The identifier of the default outbound queue for this routing profile.

description

java.lang.String description

The description of the routing profile.

Constraints:
Length: 1 - 250

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

mediaConcurrencies

java.util.List<MediaConcurrency> mediaConcurrencies

The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

name

java.lang.String name

The name of the routing profile.

Constraints:
Length: 1 - 127

routingProfileArn

java.lang.String routingProfileArn

The Amazon Resource Name (ARN) of the routing profile.

routingProfileId

java.lang.String routingProfileId

The identifier of the routing profile.

tags

java.util.Map<java.lang.String,java.lang.String> tags

One or more tags.

Class com.amazonaws.services.connect.model.RoutingProfileQueueConfig extends java.lang.Object implements Serializable

Serialized Fields

delay

java.lang.Integer delay

The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.

Constraints:
Range: 0 - 9999

priority

java.lang.Integer priority

The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.

Constraints:
Range: 1 - 99

queueReference

RoutingProfileQueueReference queueReference

Contains information about a queue resource.

Class com.amazonaws.services.connect.model.RoutingProfileQueueConfigSummary extends java.lang.Object implements Serializable

Serialized Fields

channel

java.lang.String channel

The channels this queue supports.

Constraints:
Allowed Values: VOICE, CHAT, TASK

delay

java.lang.Integer delay

The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.

Constraints:
Range: 0 - 9999

priority

java.lang.Integer priority

The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.

Constraints:
Range: 1 - 99

queueArn

java.lang.String queueArn

The Amazon Resource Name (ARN) of the queue.

queueId

java.lang.String queueId

The identifier for the queue.

queueName

java.lang.String queueName

The name of the queue.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.connect.model.RoutingProfileQueueReference extends java.lang.Object implements Serializable

Serialized Fields

channel

java.lang.String channel

The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

Constraints:
Allowed Values: VOICE, CHAT, TASK

queueId

java.lang.String queueId

The identifier for the queue.

Class com.amazonaws.services.connect.model.RoutingProfileSummary extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the routing profile.

id

java.lang.String id

The identifier of the routing profile.

name

java.lang.String name

The name of the routing profile.

Constraints:
Length: 1 - 127

Class com.amazonaws.services.connect.model.S3Config extends java.lang.Object implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The S3 bucket name.

Constraints:
Length: 1 - 128

bucketPrefix

java.lang.String bucketPrefix

The S3 bucket prefix.

Constraints:
Length: 1 - 128

encryptionConfig

EncryptionConfig encryptionConfig

The Amazon S3 encryption configuration.

Class com.amazonaws.services.connect.model.SearchAvailablePhoneNumbersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 10

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Constraints:
Length: 1 - 100000

phoneNumberCountryCode

java.lang.String phoneNumberCountryCode

The ISO country code.

Constraints:
Allowed Values: AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW

phoneNumberPrefix

java.lang.String phoneNumberPrefix

The prefix of the phone number. If provided, it must contain + as part of the country code.

Constraints:
Pattern: \\+?[0-9]{1,11}

phoneNumberType

java.lang.String phoneNumberType

The type of phone number.

Constraints:
Allowed Values: TOLL_FREE, DID

targetArn

java.lang.String targetArn

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

Class com.amazonaws.services.connect.model.SearchAvailablePhoneNumbersResult extends java.lang.Object implements Serializable

Serialized Fields

availableNumbersList

java.util.List<AvailableNumberSummary> availableNumbersList

A list of available phone numbers that you can claim for your Amazon Connect instance.

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

Constraints:
Length: 1 - 100000

Class com.amazonaws.services.connect.model.SearchUsersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Constraints:
Length: 1 - 2500

searchCriteria

UserSearchCriteria searchCriteria

The search criteria to be used to return users.

searchFilter

UserSearchFilter searchFilter

Filters to be applied to search results.

Class com.amazonaws.services.connect.model.SearchUsersResult extends java.lang.Object implements Serializable

Serialized Fields

approximateTotalCount

java.lang.Long approximateTotalCount

The total number of users who matched your search query.

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

Constraints:
Length: 1 - 2500

users

java.util.List<UserSearchSummary> users

Information about the users.

Class com.amazonaws.services.connect.model.SearchVocabulariesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

languageCode

java.lang.String languageCode

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

Constraints:
Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN

maxResults

java.lang.Integer maxResults

The maximum number of results to return per page.

Constraints:
Range: 1 - 100

nameStartsWith

java.lang.String nameStartsWith

The starting pattern of the name of the vocabulary.

Constraints:
Length: 1 - 140
Pattern: ^[0-9a-zA-Z._-]+

nextToken

java.lang.String nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Constraints:
Length: 1 - 131070
Pattern: .*\S.*

state

java.lang.String state

The current state of the custom vocabulary.

Constraints:
Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS

Class com.amazonaws.services.connect.model.SearchVocabulariesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If there are additional results, this is the token for the next set of results.

Constraints:
Length: 1 - 131070
Pattern: .*\S.*

vocabularySummaryList

java.util.List<VocabularySummary> vocabularySummaryList

The list of the available custom vocabularies.

Class com.amazonaws.services.connect.model.SecurityKey extends java.lang.Object implements Serializable

Serialized Fields

associationId

java.lang.String associationId

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

Constraints:
Length: 1 - 100

creationTime

java.util.Date creationTime

When the security key was created.

key

java.lang.String key

The key of the security key.

Constraints:
Length: 1 - 1024

Class com.amazonaws.services.connect.model.SecurityProfile extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) for the secruity profile.

description

java.lang.String description

The description of the security profile.

Constraints:
Length: - 250

id

java.lang.String id

The identifier for the security profile.

organizationResourceId

java.lang.String organizationResourceId

The organization resource identifier for the security profile.

Constraints:
Length: 1 - 100

securityProfileName

java.lang.String securityProfileName

The name for the security profile.

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

Class com.amazonaws.services.connect.model.SecurityProfileSummary extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the security profile.

id

java.lang.String id

The identifier of the security profile.

name

java.lang.String name

The name of the security profile.

Class com.amazonaws.services.connect.model.ServiceQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connect.model.StartChatContactRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

chatDurationInMinutes

java.lang.Integer chatDurationInMinutes

The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

Constraints:
Range: 60 - 10080

clientToken

java.lang.String clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:
Length: - 500

contactFlowId

java.lang.String contactFlowId

The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx- xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

Constraints:
Length: - 500

initialMessage

ChatMessage initialMessage

The initial message to be sent to the newly created chat.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

participantDetails

ParticipantDetails participantDetails

Information identifying the participant.

supportedMessagingContentTypes

java.util.List<java.lang.String> supportedMessagingContentTypes

The supported chat message content types. Content types can be text/plain or both text/plain and text/markdown.

Class com.amazonaws.services.connect.model.StartChatContactResult extends java.lang.Object implements Serializable

Serialized Fields

contactId

java.lang.String contactId

The identifier of this contact within the Amazon Connect instance.

Constraints:
Length: 1 - 256

participantId

java.lang.String participantId

The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.

Constraints:
Length: 1 - 256

participantToken

java.lang.String participantToken

The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.

Constraints:
Length: 1 - 1000

Class com.amazonaws.services.connect.model.StartContactRecordingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactId

java.lang.String contactId

The identifier of the contact.

Constraints:
Length: 1 - 256

initialContactId

java.lang.String initialContactId

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

Constraints:
Length: 1 - 256

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

voiceRecordingConfiguration

VoiceRecordingConfiguration voiceRecordingConfiguration

The person being recorded.

Class com.amazonaws.services.connect.model.StartContactRecordingResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connect.model.StartContactStreamingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

chatStreamingConfiguration

ChatStreamingConfiguration chatStreamingConfiguration

The streaming configuration, such as the Amazon SNS streaming endpoint.

clientToken

java.lang.String clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:
Length: - 500

contactId

java.lang.String contactId

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

Constraints:
Length: 1 - 256

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.StartContactStreamingResult extends java.lang.Object implements Serializable

Serialized Fields

streamingId

java.lang.String streamingId

The identifier of the streaming configuration enabled.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.StartOutboundVoiceContactRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

answerMachineDetectionConfig

AnswerMachineDetectionConfig answerMachineDetectionConfig

Configuration of the answering machine detection for this outbound call.

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

campaignId

java.lang.String campaignId

The campaign identifier of the outbound communication.

Constraints:
Length: 1 - 100

clientToken

java.lang.String clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

Constraints:
Length: - 500

contactFlowId

java.lang.String contactFlowId

The identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx- xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

Constraints:
Length: - 500

destinationPhoneNumber

java.lang.String destinationPhoneNumber

The phone number of the customer, in E.164 format.

Constraints:
Pattern: \\+[1-9]\\d{1,14}$

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

queueId

java.lang.String queueId

The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.

sourcePhoneNumber

java.lang.String sourcePhoneNumber

The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.

Constraints:
Pattern: \\+[1-9]\\d{1,14}$

trafficType

java.lang.String trafficType

Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.

Constraints:
Allowed Values: GENERAL, CAMPAIGN

Class com.amazonaws.services.connect.model.StartOutboundVoiceContactResult extends java.lang.Object implements Serializable

Serialized Fields

contactId

java.lang.String contactId

The identifier of this contact within the Amazon Connect instance.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.connect.model.StartTaskContactRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

clientToken

java.lang.String clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:
Length: - 500

contactFlowId

java.lang.String contactFlowId

The identifier of the contact flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx- xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

Constraints:
Length: - 500

description

java.lang.String description

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

Constraints:
Length: 0 - 4096

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

name

java.lang.String name

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

Constraints:
Length: 0 - 512

previousContactId

java.lang.String previousContactId

The identifier of the previous chat, voice, or task contact.

Constraints:
Length: 1 - 256

references

java.util.Map<java.lang.String,Reference> references

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

scheduledTime

java.util.Date scheduledTime

The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

Class com.amazonaws.services.connect.model.StartTaskContactResult extends java.lang.Object implements Serializable

Serialized Fields

contactId

java.lang.String contactId

The identifier of this contact within the Amazon Connect instance.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.connect.model.StopContactRecordingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactId

java.lang.String contactId

The identifier of the contact.

Constraints:
Length: 1 - 256

initialContactId

java.lang.String initialContactId

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

Constraints:
Length: 1 - 256

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.StopContactRecordingResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connect.model.StopContactRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactId

java.lang.String contactId

The ID of the contact.

Constraints:
Length: 1 - 256

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.StopContactResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connect.model.StopContactStreamingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactId

java.lang.String contactId

The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.

Constraints:
Length: 1 - 256

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

streamingId

java.lang.String streamingId

The identifier of the streaming configuration enabled.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.StopContactStreamingResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connect.model.StringCondition extends java.lang.Object implements Serializable

Serialized Fields

comparisonType

java.lang.String comparisonType

The type of comparison to be made when evaluating the string condition.

Constraints:
Allowed Values: STARTS_WITH, CONTAINS, EXACT

fieldName

java.lang.String fieldName

The name of the field in the string condition.

value

java.lang.String value

The value of the string.

Class com.amazonaws.services.connect.model.SuspendContactRecordingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactId

java.lang.String contactId

The identifier of the contact.

Constraints:
Length: 1 - 256

initialContactId

java.lang.String initialContactId

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

Constraints:
Length: 1 - 256

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.SuspendContactRecordingResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connect.model.TagCondition extends java.lang.Object implements Serializable

Serialized Fields

tagKey

java.lang.String tagKey

The tag key in the tag condition.

tagValue

java.lang.String tagValue

The tag value in the tag condition.

Class com.amazonaws.services.connect.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the resource.

tags

java.util.Map<java.lang.String,java.lang.String> tags

One or more tags. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Class com.amazonaws.services.connect.model.Threshold extends java.lang.Object implements Serializable

Serialized Fields

comparison

java.lang.String comparison

The type of comparison. Only "less than" (LT) comparisons are supported.

Constraints:
Allowed Values: LT

thresholdValue

java.lang.Double thresholdValue

The threshold value to compare.

Class com.amazonaws.services.connect.model.ThrottlingException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connect.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the resource.

tagKeys

java.util.List<java.lang.String> tagKeys

The tag keys.

Class com.amazonaws.services.connect.model.UpdateAgentStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

agentStatusId

java.lang.String agentStatusId

The identifier of the agent status.

description

java.lang.String description

The description of the agent status.

Constraints:
Length: 0 - 250

displayOrder

java.lang.Integer displayOrder

The display order of the agent status.

Constraints:
Range: 1 - 50

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

name

java.lang.String name

The name of the agent status.

Constraints:
Length: 1 - 127

resetOrderNumber

java.lang.Boolean resetOrderNumber

A number indicating the reset order of the agent status.

state

java.lang.String state

The state of the agent status.

Constraints:
Allowed Values: ENABLED, DISABLED

Class com.amazonaws.services.connect.model.UpdateContactAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

The Amazon Connect attributes. These attributes can be accessed in contact flows just like any other contact attributes.

You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

initialContactId

java.lang.String initialContactId

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

Constraints:
Length: 1 - 256

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.UpdateContactAttributesResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connect.model.UpdateContactFlowContentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactFlowId

java.lang.String contactFlowId

The identifier of the contact flow.

Constraints:
Length: - 500

content

java.lang.String content

The JSON string that represents contact flow’s content. For an example, see Example contact flow in Amazon Connect Flow language in the Amazon Connect Administrator Guide.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.UpdateContactFlowMetadataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactFlowId

java.lang.String contactFlowId

The identifier of the contact flow.

Constraints:
Length: - 500

contactFlowState

java.lang.String contactFlowState

The state of contact flow.

Constraints:
Allowed Values: ACTIVE, ARCHIVED

description

java.lang.String description

The description of the contact flow.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

name

java.lang.String name

TThe name of the contact flow.

Constraints:
Length: 1 -

Class com.amazonaws.services.connect.model.UpdateContactFlowModuleContentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactFlowModuleId

java.lang.String contactFlowModuleId

The identifier of the contact flow module.

Constraints:
Length: 1 - 256

content

java.lang.String content

The content of the contact flow module.

Constraints:
Length: 1 - 256000

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.UpdateContactFlowModuleContentResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connect.model.UpdateContactFlowModuleMetadataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactFlowModuleId

java.lang.String contactFlowModuleId

The identifier of the contact flow module.

Constraints:
Length: 1 - 256

description

java.lang.String description

The description of the contact flow module.

Constraints:
Length: 0 - 500
Pattern: .*\S.*

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

name

java.lang.String name

The name of the contact flow module.

Constraints:
Length: 1 - 127
Pattern: .*\S.*

state

java.lang.String state

The state of contact flow module.

Constraints:
Allowed Values: ACTIVE, ARCHIVED

Class com.amazonaws.services.connect.model.UpdateContactFlowModuleMetadataResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connect.model.UpdateContactFlowNameRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactFlowId

java.lang.String contactFlowId

The identifier of the contact flow.

Constraints:
Length: - 500

description

java.lang.String description

The description of the contact flow.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance.

Constraints:
Length: 1 - 100

name

java.lang.String name

The name of the contact flow.

Constraints:
Length: 1 -

Class com.amazonaws.services.connect.model.UpdateContactRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactId

java.lang.String contactId

The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.

Constraints:
Length: 1 - 256

description

java.lang.String description

The description of the contact.

Constraints:
Length: 0 - 4096

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

name

java.lang.String name

The name of the contact.

Constraints:
Length: 0 - 512

references

java.util.Map<java.lang.String,Reference> references

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

Class com.amazonaws.services.connect.model.UpdateContactResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connect.model.UpdateContactScheduleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contactId

java.lang.String contactId

The identifier of the contact.

Constraints:
Length: 1 - 256

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

scheduledTime

java.util.Date scheduledTime

The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

Class com.amazonaws.services.connect.model.UpdateContactScheduleResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connect.model.UpdateHoursOfOperationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

config

java.util.List<HoursOfOperationConfig> config

Configuration information of the hours of operation.

description

java.lang.String description

The description of the hours of operation.

Constraints:
Length: 0 - 250

hoursOfOperationId

java.lang.String hoursOfOperationId

The identifier of the hours of operation.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

name

java.lang.String name

The name of the hours of operation.

Constraints:
Length: 1 - 127

timeZone

java.lang.String timeZone

The time zone of the hours of operation.

Class com.amazonaws.services.connect.model.UpdateInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeType

java.lang.String attributeType

The type of attribute.

Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting.

Constraints:
Allowed Values: INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA, MULTI_PARTY_CONFERENCE

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

value

java.lang.String value

The value for the attribute. Maximum character limit is 100.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.UpdateInstanceStorageConfigRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

associationId

java.lang.String associationId

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

Constraints:
Length: 1 - 100

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

resourceType

java.lang.String resourceType

A valid resource type.

Constraints:
Allowed Values: CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS, REAL_TIME_CONTACT_ANALYSIS_SEGMENTS

storageConfig

InstanceStorageConfig storageConfig

The storage configuration for the instance.

Class com.amazonaws.services.connect.model.UpdatePhoneNumberRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:
Length: - 500

phoneNumberId

java.lang.String phoneNumberId

A unique identifier for the phone number.

targetArn

java.lang.String targetArn

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

Class com.amazonaws.services.connect.model.UpdatePhoneNumberResult extends java.lang.Object implements Serializable

Serialized Fields

phoneNumberArn

java.lang.String phoneNumberArn

The Amazon Resource Name (ARN) of the phone number.

phoneNumberId

java.lang.String phoneNumberId

A unique identifier for the phone number.

Class com.amazonaws.services.connect.model.UpdateQueueHoursOfOperationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

hoursOfOperationId

java.lang.String hoursOfOperationId

The identifier for the hours of operation.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

queueId

java.lang.String queueId

The identifier for the queue.

Class com.amazonaws.services.connect.model.UpdateQueueMaxContactsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

maxContacts

java.lang.Integer maxContacts

The maximum number of contacts that can be in the queue before it is considered full.

Constraints:
Range: 0 -

queueId

java.lang.String queueId

The identifier for the queue.

Class com.amazonaws.services.connect.model.UpdateQueueNameRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

The description of the queue.

Constraints:
Length: 1 - 250

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

name

java.lang.String name

The name of the queue.

Constraints:
Length: 1 - 127

queueId

java.lang.String queueId

The identifier for the queue.

Class com.amazonaws.services.connect.model.UpdateQueueOutboundCallerConfigRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

outboundCallerConfig

OutboundCallerConfig outboundCallerConfig

The outbound caller ID name, number, and outbound whisper flow.

queueId

java.lang.String queueId

The identifier for the queue.

Class com.amazonaws.services.connect.model.UpdateQueueStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

queueId

java.lang.String queueId

The identifier for the queue.

status

java.lang.String status

The status of the queue.

Constraints:
Allowed Values: ENABLED, DISABLED

Class com.amazonaws.services.connect.model.UpdateQuickConnectConfigRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

quickConnectConfig

QuickConnectConfig quickConnectConfig

Information about the configuration settings for the quick connect.

quickConnectId

java.lang.String quickConnectId

The identifier for the quick connect.

Class com.amazonaws.services.connect.model.UpdateQuickConnectNameRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

The description of the quick connect.

Constraints:
Length: 0 - 250

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

name

java.lang.String name

The name of the quick connect.

Constraints:
Length: 1 - 127

quickConnectId

java.lang.String quickConnectId

The identifier for the quick connect.

Class com.amazonaws.services.connect.model.UpdateRoutingProfileConcurrencyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

mediaConcurrencies

java.util.List<MediaConcurrency> mediaConcurrencies

The channels that agents can handle in the Contact Control Panel (CCP).

routingProfileId

java.lang.String routingProfileId

The identifier of the routing profile.

Class com.amazonaws.services.connect.model.UpdateRoutingProfileDefaultOutboundQueueRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

defaultOutboundQueueId

java.lang.String defaultOutboundQueueId

The identifier for the default outbound queue.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

routingProfileId

java.lang.String routingProfileId

The identifier of the routing profile.

Class com.amazonaws.services.connect.model.UpdateRoutingProfileNameRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

The description of the routing profile. Must not be more than 250 characters.

Constraints:
Length: 1 - 250

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

name

java.lang.String name

The name of the routing profile. Must not be more than 127 characters.

Constraints:
Length: 1 - 127

routingProfileId

java.lang.String routingProfileId

The identifier of the routing profile.

Class com.amazonaws.services.connect.model.UpdateRoutingProfileQueuesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

queueConfigs

java.util.List<RoutingProfileQueueConfig> queueConfigs

The queues to be updated for this routing profile. Queues must first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.

routingProfileId

java.lang.String routingProfileId

The identifier of the routing profile.

Class com.amazonaws.services.connect.model.UpdateSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

The description of the security profile.

Constraints:
Length: - 250

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

permissions

java.util.List<java.lang.String> permissions

The permissions granted to a security profile.

securityProfileId

java.lang.String securityProfileId

The identifier for the security profle.

Class com.amazonaws.services.connect.model.UpdateUserHierarchyGroupNameRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

hierarchyGroupId

java.lang.String hierarchyGroupId

The identifier of the hierarchy group.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

name

java.lang.String name

The name of the hierarchy group. Must not be more than 100 characters.

Class com.amazonaws.services.connect.model.UpdateUserHierarchyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

hierarchyGroupId

java.lang.String hierarchyGroupId

The identifier of the hierarchy group.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

userId

java.lang.String userId

The identifier of the user account.

Class com.amazonaws.services.connect.model.UpdateUserHierarchyStructureRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

hierarchyStructure

HierarchyStructureUpdate hierarchyStructure

The hierarchy levels to update.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.UpdateUserIdentityInfoRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityInfo

UserIdentityInfo identityInfo

The identity information for the user.

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

userId

java.lang.String userId

The identifier of the user account.

Class com.amazonaws.services.connect.model.UpdateUserPhoneConfigRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

phoneConfig

UserPhoneConfig phoneConfig

Information about phone configuration settings for the user.

userId

java.lang.String userId

The identifier of the user account.

Class com.amazonaws.services.connect.model.UpdateUserRoutingProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

routingProfileId

java.lang.String routingProfileId

The identifier of the routing profile for the user.

userId

java.lang.String userId

The identifier of the user account.

Class com.amazonaws.services.connect.model.UpdateUserSecurityProfilesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Constraints:
Length: 1 - 100

securityProfileIds

java.util.List<java.lang.String> securityProfileIds

The identifiers of the security profiles for the user.

userId

java.lang.String userId

The identifier of the user account.

Class com.amazonaws.services.connect.model.UrlReference extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

Identifier of the URL reference.

Constraints:
Length: 1 - 4096

value

java.lang.String value

A valid URL.

Constraints:
Length: 0 - 4096

Class com.amazonaws.services.connect.model.UseCase extends java.lang.Object implements Serializable

Serialized Fields

useCaseArn

java.lang.String useCaseArn

The Amazon Resource Name (ARN) for the use case.

useCaseId

java.lang.String useCaseId

The identifier for the use case.

Constraints:
Length: 1 - 200

useCaseType

java.lang.String useCaseType

The type of use case to associate to the integration association. Each integration association can have only one of each use case type.

Constraints:
Allowed Values: RULES_EVALUATION, CONNECT_CAMPAIGNS

Class com.amazonaws.services.connect.model.User extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the user account.

directoryUserId

java.lang.String directoryUserId

The identifier of the user account in the directory used for identity management.

hierarchyGroupId

java.lang.String hierarchyGroupId

The identifier of the hierarchy group for the user.

id

java.lang.String id

The identifier of the user account.

identityInfo

UserIdentityInfo identityInfo

Information about the user identity.

phoneConfig

UserPhoneConfig phoneConfig

Information about the phone configuration for the user.

routingProfileId

java.lang.String routingProfileId

The identifier of the routing profile for the user.

securityProfileIds

java.util.List<java.lang.String> securityProfileIds

The identifiers of the security profiles for the user.

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags.

username

java.lang.String username

The user name assigned to the user account.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.UserIdentityInfo extends java.lang.Object implements Serializable

Serialized Fields

email

java.lang.String email

The email address. If you are using SAML for identity management and include this parameter, an error is returned.

firstName

java.lang.String firstName

The first name. This is required if you are using Amazon Connect or SAML for identity management.

Constraints:
Length: 1 - 100

lastName

java.lang.String lastName

The last name. This is required if you are using Amazon Connect or SAML for identity management.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.UserIdentityInfoLite extends java.lang.Object implements Serializable

Serialized Fields

firstName

java.lang.String firstName

The user's first name.

Constraints:
Length: 1 - 100

lastName

java.lang.String lastName

The user's last name.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.UserNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connect.model.UserPhoneConfig extends java.lang.Object implements Serializable

Serialized Fields

afterContactWorkTimeLimit

java.lang.Integer afterContactWorkTimeLimit

The After Call Work (ACW) timeout setting, in seconds.

Constraints:
Range: 0 -

autoAccept

java.lang.Boolean autoAccept

The Auto accept setting.

deskPhoneNumber

java.lang.String deskPhoneNumber

The phone number for the user's desk phone.

Constraints:
Pattern: \\+[1-9]\\d{1,14}$

phoneType

java.lang.String phoneType

The phone type.

Constraints:
Allowed Values: SOFT_PHONE, DESK_PHONE

Class com.amazonaws.services.connect.model.UserQuickConnectConfig extends java.lang.Object implements Serializable

Serialized Fields

contactFlowId

java.lang.String contactFlowId

The identifier of the contact flow.

Constraints:
Length: - 500

userId

java.lang.String userId

The identifier of the user.

Class com.amazonaws.services.connect.model.UserSearchCriteria extends java.lang.Object implements Serializable

Serialized Fields

andConditions

java.util.List<UserSearchCriteria> andConditions

A list of conditions which would be applied together with an AND condition.

hierarchyGroupCondition

HierarchyGroupCondition hierarchyGroupCondition

A leaf node condition which can be used to specify a hierarchy group condition.

orConditions

java.util.List<UserSearchCriteria> orConditions

A list of conditions which would be applied together with an OR condition.

stringCondition

StringCondition stringCondition

A leaf node condition which can be used to specify a string condition.

Class com.amazonaws.services.connect.model.UserSearchFilter extends java.lang.Object implements Serializable

Serialized Fields

tagFilter

ControlPlaneTagFilter tagFilter

An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:

• Top level list specifies conditions that need to be applied with OR operator

• Inner list specifies conditions that need to be applied with AND operator.

Class com.amazonaws.services.connect.model.UserSearchSummary extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the user.

directoryUserId

java.lang.String directoryUserId

The directory identifier of the user.

hierarchyGroupId

java.lang.String hierarchyGroupId

The identifier of the user's hierarchy group.

id

java.lang.String id

The identifier of the user's summary.

identityInfo

UserIdentityInfoLite identityInfo

The user's first name and last name.

phoneConfig

UserPhoneConfig phoneConfig

Contains information about the phone configuration settings for a user.

routingProfileId

java.lang.String routingProfileId

The identifier of the user's routing profile.

securityProfileIds

java.util.List<java.lang.String> securityProfileIds

The identifiers of the user's security profiles.

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

username

java.lang.String username

The name of the user.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.UserSummary extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the user account.

id

java.lang.String id

The identifier of the user account.

username

java.lang.String username

The Amazon Connect user name of the user account.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connect.model.Vocabulary extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the custom vocabulary.

content

java.lang.String content

The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.

Constraints:
Length: 1 - 60000

failureReason

java.lang.String failureReason

The reason why the custom vocabulary was not created.

id

java.lang.String id

The identifier of the custom vocabulary.

Constraints:
Length: 1 - 500

languageCode

java.lang.String languageCode

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

Constraints:
Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN

lastModifiedTime

java.util.Date lastModifiedTime

The timestamp when the custom vocabulary was last modified.

name

java.lang.String name

A unique name of the custom vocabulary.

Constraints:
Length: 1 - 140
Pattern: ^[0-9a-zA-Z._-]+

state

java.lang.String state

The current state of the custom vocabulary.

Constraints:
Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags used to organize, track, or control access for this resource.

Class com.amazonaws.services.connect.model.VocabularySummary extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the custom vocabulary.

failureReason

java.lang.String failureReason

The reason why the custom vocabulary was not created.

id

java.lang.String id

The identifier of the custom vocabulary.

Constraints:
Length: 1 - 500

languageCode

java.lang.String languageCode

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

Constraints:
Allowed Values: ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN

lastModifiedTime

java.util.Date lastModifiedTime

The timestamp when the custom vocabulary was last modified.

name

java.lang.String name

A unique name of the custom vocabulary.

Constraints:
Length: 1 - 140
Pattern: ^[0-9a-zA-Z._-]+

state

java.lang.String state

The current state of the custom vocabulary.

Constraints:
Allowed Values: CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS

Class com.amazonaws.services.connect.model.VoiceRecordingConfiguration extends java.lang.Object implements Serializable

Serialized Fields

voiceRecordingTrack

java.lang.String voiceRecordingTrack

Identifies which track is being recorded.

Constraints:
Allowed Values: FROM_AGENT, TO_AGENT, ALL

Package com.amazonaws.services.connectparticipant.model

Class com.amazonaws.services.connectparticipant.model.AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connectparticipant.model.AttachmentItem extends java.lang.Object implements Serializable

Serialized Fields

attachmentId

java.lang.String attachmentId

A unique identifier for the attachment.

Constraints:
Length: 1 - 256

attachmentName

java.lang.String attachmentName

A case-sensitive name of the attachment being uploaded.

Constraints:
Length: 1 - 256

contentType

java.lang.String contentType

Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.

Constraints:
Length: 1 - 255

status

java.lang.String status

Status of the attachment.

Constraints:
Allowed Values: APPROVED, REJECTED, IN_PROGRESS

Class com.amazonaws.services.connectparticipant.model.CompleteAttachmentUploadRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attachmentIds

java.util.List<java.lang.String> attachmentIds

A list of unique identifiers for the attachments.

clientToken

java.lang.String clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:
Length: 1 - 500

connectionToken

java.lang.String connectionToken

The authentication token associated with the participant's connection.

Constraints:
Length: 1 - 1000

Class com.amazonaws.services.connectparticipant.model.CompleteAttachmentUploadResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connectparticipant.model.ConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connectparticipant.model.ConnectionCredentials extends java.lang.Object implements Serializable

Serialized Fields

connectionToken

java.lang.String connectionToken

The connection token.

Constraints:
Length: 1 - 1000

expiry

java.lang.String expiry

The expiration of the token.

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

Class com.amazonaws.services.connectparticipant.model.CreateParticipantConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

connectParticipant

java.lang.Boolean connectParticipant

Amazon Connect Participant is used to mark the participant as connected for message streaming.

participantToken

java.lang.String participantToken

This is a header parameter.

The ParticipantToken as obtained from StartChatContact API response.

Constraints:
Length: 1 - 1000

type

java.util.List<java.lang.String> type

Type of connection information required.

Class com.amazonaws.services.connectparticipant.model.CreateParticipantConnectionResult extends java.lang.Object implements Serializable

Serialized Fields

connectionCredentials

ConnectionCredentials connectionCredentials

Creates the participant's connection credentials. The authentication token associated with the participant's connection.

websocket

Websocket websocket

Creates the participant's websocket connection.

Class com.amazonaws.services.connectparticipant.model.DisconnectParticipantRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:
Length: - 500

connectionToken

java.lang.String connectionToken

The authentication token associated with the participant's connection.

Constraints:
Length: 1 - 1000

Class com.amazonaws.services.connectparticipant.model.DisconnectParticipantResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.connectparticipant.model.GetAttachmentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attachmentId

java.lang.String attachmentId

A unique identifier for the attachment.

Constraints:
Length: 1 - 256

connectionToken

java.lang.String connectionToken

The authentication token associated with the participant's connection.

Constraints:
Length: 1 - 1000

Class com.amazonaws.services.connectparticipant.model.GetAttachmentResult extends java.lang.Object implements Serializable

Serialized Fields

url

java.lang.String url

This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.

Constraints:
Length: 1 - 2000

urlExpiry

java.lang.String urlExpiry

The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

Class com.amazonaws.services.connectparticipant.model.GetTranscriptRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

connectionToken

java.lang.String connectionToken

The authentication token associated with the participant's connection.

Constraints:
Length: 1 - 1000

contactId

java.lang.String contactId

The contactId from the current contact chain for which transcript is needed.

Constraints:
Length: 1 - 256

maxResults

java.lang.Integer maxResults

The maximum number of results to return in the page. Default: 10.

Constraints:
Range: 0 - 100

nextToken

java.lang.String nextToken

The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

Constraints:
Length: 1 - 1000

scanDirection

java.lang.String scanDirection

The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

Constraints:
Allowed Values: FORWARD, BACKWARD

sortOrder

java.lang.String sortOrder

The sort order for the records. Default: DESCENDING.

Constraints:
Allowed Values: DESCENDING, ASCENDING

startPosition

StartPosition startPosition

A filtering option for where to start.

Class com.amazonaws.services.connectparticipant.model.GetTranscriptResult extends java.lang.Object implements Serializable

Serialized Fields

initialContactId

java.lang.String initialContactId

The initial contact ID for the contact.

Constraints:
Length: 1 - 256

nextToken

java.lang.String nextToken

The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

Constraints:
Length: 1 - 1000

transcript

java.util.List<Item> transcript

The list of messages in the session.

Class com.amazonaws.services.connectparticipant.model.InternalServerException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connectparticipant.model.Item extends java.lang.Object implements Serializable

Serialized Fields

absoluteTime

java.lang.String absoluteTime

The time when the message or event was sent.

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

Constraints:
Length: 1 - 100

attachments

java.util.List<AttachmentItem> attachments

Provides information about the attachments.

content

java.lang.String content

The content of the message or event.

Constraints:
Length: 1 - 1024

contentType

java.lang.String contentType

The type of content of the item.

Constraints:
Length: 1 - 100

displayName

java.lang.String displayName

The chat display name of the sender.

Constraints:
Length: 1 - 256

id

java.lang.String id

The ID of the item.

Constraints:
Length: 1 - 256

participantId

java.lang.String participantId

The ID of the sender in the session.

Constraints:
Length: 1 - 256

participantRole

java.lang.String participantRole

The role of the sender. For example, is it a customer, agent, or system.

Constraints:
Allowed Values: AGENT, CUSTOMER, SYSTEM

type

java.lang.String type

Type of the item: message or event.

Constraints:
Allowed Values: TYPING, PARTICIPANT_JOINED, PARTICIPANT_LEFT, CHAT_ENDED, TRANSFER_SUCCEEDED, TRANSFER_FAILED, MESSAGE, EVENT, ATTACHMENT, CONNECTION_ACK

Class com.amazonaws.services.connectparticipant.model.SendEventRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:
Length: - 500

connectionToken

java.lang.String connectionToken

The authentication token associated with the participant's connection.

Constraints:
Length: 1 - 1000

content

java.lang.String content

The content of the event to be sent (for example, message text). This is not yet supported.

Constraints:
Length: 1 - 1024

contentType

java.lang.String contentType

The content type of the request. Supported types are:

• application/vnd.amazonaws.connect.event.typing

• application/vnd.amazonaws.connect.event.connection.acknowledged

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connectparticipant.model.SendEventResult extends java.lang.Object implements Serializable

Serialized Fields

absoluteTime

java.lang.String absoluteTime

The time when the event was sent.

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

Constraints:
Length: 1 - 100

id

java.lang.String id

The ID of the response.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.connectparticipant.model.SendMessageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:
Length: - 500

connectionToken

java.lang.String connectionToken

The authentication token associated with the connection.

Constraints:
Length: 1 - 1000

content

java.lang.String content

The content of the message.

Constraints:
Length: 1 - 1024

contentType

java.lang.String contentType

The type of the content. Supported types are text/plain.

Constraints:
Length: 1 - 100

Class com.amazonaws.services.connectparticipant.model.SendMessageResult extends java.lang.Object implements Serializable

Serialized Fields

absoluteTime

java.lang.String absoluteTime

The time when the message was sent.

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

Constraints:
Length: 1 - 100

id

java.lang.String id

The ID of the message.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.connectparticipant.model.ServiceQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connectparticipant.model.StartAttachmentUploadRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attachmentName

java.lang.String attachmentName

A case-sensitive name of the attachment being uploaded.

Constraints:
Length: 1 - 256

attachmentSizeInBytes

java.lang.Long attachmentSizeInBytes

The size of the attachment in bytes.

Constraints:
Range: 1 -

clientToken

java.lang.String clientToken

A unique case sensitive identifier to support idempotency of request.

Constraints:
Length: 1 - 500

connectionToken

java.lang.String connectionToken

The authentication token associated with the participant's connection.

Constraints:
Length: 1 - 1000

contentType

java.lang.String contentType

Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.

Constraints:
Length: 1 - 255

Class com.amazonaws.services.connectparticipant.model.StartAttachmentUploadResult extends java.lang.Object implements Serializable

Serialized Fields

attachmentId

java.lang.String attachmentId

A unique identifier for the attachment.

Constraints:
Length: 1 - 256

uploadMetadata

UploadMetadata uploadMetadata

Fields to be used while uploading the attachment.

Class com.amazonaws.services.connectparticipant.model.StartPosition extends java.lang.Object implements Serializable

Serialized Fields

absoluteTime

java.lang.String absoluteTime

The time in ISO format where to start.

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

Constraints:
Length: 1 - 100

id

java.lang.String id

The ID of the message or event where to start.

Constraints:
Length: 1 - 256

mostRecent

java.lang.Integer mostRecent

The start position of the most recent message where you want to start.

Constraints:
Range: 0 - 100

Class com.amazonaws.services.connectparticipant.model.ThrottlingException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connectparticipant.model.UploadMetadata extends java.lang.Object implements Serializable

Serialized Fields

headersToInclude

java.util.Map<java.lang.String,java.lang.String> headersToInclude

The headers to be provided while uploading the file to the URL.

url

java.lang.String url

This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.

Constraints:
Length: 1 - 2000

urlExpiry

java.lang.String urlExpiry

The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

Class com.amazonaws.services.connectparticipant.model.ValidationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.connectparticipant.model.Websocket extends java.lang.Object implements Serializable

Serialized Fields

connectionExpiry

java.lang.String connectionExpiry

The URL expiration timestamp in ISO date format.

It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

url

java.lang.String url

The URL of the websocket.

Constraints:
Length: 1 - 2000

Package com.amazonaws.services.dynamodbv2.model

Class com.amazonaws.services.dynamodbv2.model.AttributeDefinition extends java.lang.Object implements Serializable

Serialized Fields

attributeName

java.lang.String attributeName

A name for the attribute.

Constraints:
Length: 1 - 255

attributeType

java.lang.String attributeType

The data type for the attribute, where:

• S - the attribute is of type String

• N - the attribute is of type Number

• B - the attribute is of type Binary

Constraints:
Allowed Values: S, N, B

Class com.amazonaws.services.dynamodbv2.model.AttributeValue extends java.lang.Object implements Serializable

Serialized Fields

b

java.nio.ByteBuffer b

An attribute of type Binary. For example:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

bOOL

java.lang.Boolean bOOL

An attribute of type Boolean. For example:

"BOOL": true

bS

java.util.List<java.nio.ByteBuffer> bS

An attribute of type Binary Set. For example:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

l

java.util.List<AttributeValue> l

An attribute of type List. For example:

"L": ["Cookies", "Coffee", 3.14159]

m

java.util.Map<java.lang.String,AttributeValue> m

An attribute of type Map. For example:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

n

java.lang.String n

An attribute of type Number. For example:

"N": "123.45"

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

nS

java.util.List<java.lang.String> nS

An attribute of type Number Set. For example:

"NS": ["42.2", "-19", "7.5", "3.14"]

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

nULL

java.lang.Boolean nULL

An attribute of type Null. For example:

"NULL": true

s

java.lang.String s

An attribute of type String. For example:

"S": "Hello"

sS

java.util.List<java.lang.String> sS

An attribute of type String Set. For example:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

Class com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate extends java.lang.Object implements Serializable

Serialized Fields

action

java.lang.String action

Specifies how to perform the update. Valid values are PUT (default), DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table.

If an item with the specified Key is found in the table:

• PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.

• DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.

  If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error.

• ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

  • If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

    If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

    In addition, if you use ADD to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

  • If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2], and the ADD action specified [3], then the final attribute value would be [1,2,3]. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.

    Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.

  This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types.

If no item with the specified Key is found:

• PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute.

• DELETE - Nothing happens; there is no attribute to delete.

• ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.

Constraints:
Allowed Values: ADD, PUT, DELETE

value

AttributeValue value

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Class com.amazonaws.services.dynamodbv2.model.AutoScalingPolicyDescription extends java.lang.Object implements Serializable

Serialized Fields

policyName

java.lang.String policyName

The name of the scaling policy.

Constraints:
Length: 1 - 256
Pattern: \p{Print}+

targetTrackingScalingPolicyConfiguration

AutoScalingTargetTrackingScalingPolicyConfigurationDescription targetTrackingScalingPolicyConfiguration

Represents a target tracking scaling policy configuration.

Class com.amazonaws.services.dynamodbv2.model.AutoScalingPolicyUpdate extends java.lang.Object implements Serializable

Serialized Fields

policyName

java.lang.String policyName

The name of the scaling policy.

Constraints:
Length: 1 - 256
Pattern: \p{Print}+

targetTrackingScalingPolicyConfiguration

AutoScalingTargetTrackingScalingPolicyConfigurationUpdate targetTrackingScalingPolicyConfiguration

Represents a target tracking scaling policy configuration.

Class com.amazonaws.services.dynamodbv2.model.AutoScalingSettingsDescription extends java.lang.Object implements Serializable

Serialized Fields

autoScalingDisabled

java.lang.Boolean autoScalingDisabled

Disabled autoscaling for this global table or global secondary index.

autoScalingRoleArn

java.lang.String autoScalingRoleArn

Role ARN used for configuring autoScaling policy.

maximumUnits

java.lang.Long maximumUnits

The maximum capacity units that a global table or global secondary index should be scaled up to.

Constraints:
Range: 1 -

minimumUnits

java.lang.Long minimumUnits

The minimum capacity units that a global table or global secondary index should be scaled down to.

Constraints:
Range: 1 -

scalingPolicies

java.util.List<AutoScalingPolicyDescription> scalingPolicies

Information about the scaling policies.

Class com.amazonaws.services.dynamodbv2.model.AutoScalingSettingsUpdate extends java.lang.Object implements Serializable

Serialized Fields

autoScalingDisabled

java.lang.Boolean autoScalingDisabled

Disabled autoscaling for this global table or global secondary index.

autoScalingRoleArn

java.lang.String autoScalingRoleArn

Role ARN used for configuring autoscaling policy.

Constraints:
Length: 1 - 1600
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

maximumUnits

java.lang.Long maximumUnits

The maximum capacity units that a global table or global secondary index should be scaled up to.

Constraints:
Range: 1 -

minimumUnits

java.lang.Long minimumUnits

The minimum capacity units that a global table or global secondary index should be scaled down to.

Constraints:
Range: 1 -

scalingPolicyUpdate

AutoScalingPolicyUpdate scalingPolicyUpdate

The scaling policy to apply for scaling target global table or global secondary index capacity units.

Class com.amazonaws.services.dynamodbv2.model.AutoScalingTargetTrackingScalingPolicyConfigurationDescription extends java.lang.Object implements Serializable

Serialized Fields

disableScaleIn

java.lang.Boolean disableScaleIn

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

scaleInCooldown

java.lang.Integer scaleInCooldown

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

scaleOutCooldown

java.lang.Integer scaleOutCooldown

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

targetValue

java.lang.Double targetValue

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

Class com.amazonaws.services.dynamodbv2.model.AutoScalingTargetTrackingScalingPolicyConfigurationUpdate extends java.lang.Object implements Serializable

Serialized Fields

disableScaleIn

java.lang.Boolean disableScaleIn

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

scaleInCooldown

java.lang.Integer scaleInCooldown

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

scaleOutCooldown

java.lang.Integer scaleOutCooldown

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

targetValue

java.lang.Double targetValue

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

Class com.amazonaws.services.dynamodbv2.model.BackupDescription extends java.lang.Object implements Serializable

Serialized Fields

backupDetails

BackupDetails backupDetails

Contains the details of the backup created for the table.

sourceTableDetails

SourceTableDetails sourceTableDetails

Contains the details of the table when the backup was created.

sourceTableFeatureDetails

SourceTableFeatureDetails sourceTableFeatureDetails

Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.

Class com.amazonaws.services.dynamodbv2.model.BackupDetails extends java.lang.Object implements Serializable

Serialized Fields

backupArn

java.lang.String backupArn

ARN associated with the backup.

Constraints:
Length: 37 - 1024

backupCreationDateTime

java.util.Date backupCreationDateTime

Time at which the backup was created. This is the request time of the backup.

backupExpiryDateTime

java.util.Date backupExpiryDateTime

Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

backupName

java.lang.String backupName

Name of the requested backup.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

backupSizeBytes

java.lang.Long backupSizeBytes

Size of the backup in bytes.

Constraints:
Range: 0 -

backupStatus

java.lang.String backupStatus

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

Constraints:
Allowed Values: CREATING, DELETED, AVAILABLE

backupType

java.lang.String backupType

BackupType:

• USER - On-demand backup created by you.

• SYSTEM - On-demand backup automatically created by DynamoDB.

Constraints:
Allowed Values: USER, SYSTEM

Class com.amazonaws.services.dynamodbv2.model.BackupInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.BackupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.BackupSummary extends java.lang.Object implements Serializable

Serialized Fields

backupArn

java.lang.String backupArn

ARN associated with the backup.

Constraints:
Length: 37 - 1024

backupCreationDateTime

java.util.Date backupCreationDateTime

Time at which the backup was created.

backupExpiryDateTime

java.util.Date backupExpiryDateTime

Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

backupName

java.lang.String backupName

Name of the specified backup.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

backupSizeBytes

java.lang.Long backupSizeBytes

Size of the backup in bytes.

Constraints:
Range: 0 -

backupStatus

java.lang.String backupStatus

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

Constraints:
Allowed Values: CREATING, DELETED, AVAILABLE

backupType

java.lang.String backupType

BackupType:

• USER - On-demand backup created by you.

• SYSTEM - On-demand backup automatically created by DynamoDB.

Constraints:
Allowed Values: USER, SYSTEM

tableArn

java.lang.String tableArn

ARN associated with the table.

tableId

java.lang.String tableId

Unique identifier for the table.

Constraints:
Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

tableName

java.lang.String tableName

Name of the table.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.BatchGetItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

requestItems

java.util.Map<java.lang.String,KeysAndAttributes> requestItems

A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per BatchGetItem request.

Each element in the map of items to retrieve consists of the following:

• ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.

• ExpressionAttributeNames - One or more substitution tokens for attribute names in the ProjectionExpression parameter. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

  Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

  The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {"#P":"Percentile"}

  You could then use this substitution in an expression, as in this example:

  • #P = :val

  Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

  For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

• Keys - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide both the partition key value and the sort key value.

• ProjectionExpression - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

  If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

  For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

• AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

returnConsumedCapacity

java.lang.String returnConsumedCapacity

Determines the level of detail about provisioned throughput consumption that is returned in the response:

• INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

  Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

• TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

• NONE - No ConsumedCapacity details are included in the response.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

Class com.amazonaws.services.dynamodbv2.model.BatchGetItemResult extends java.lang.Object implements Serializable

Serialized Fields

consumedCapacity

java.util.List<ConsumedCapacity> consumedCapacity

The read capacity units consumed by the entire BatchGetItem operation.

Each element consists of:

• TableName - The table that consumed the provisioned throughput.

• CapacityUnits - The total number of capacity units consumed.

responses

java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,AttributeValue>>> responses

A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.

unprocessedKeys

java.util.Map<java.lang.String,KeysAndAttributes> unprocessedKeys

A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each element consists of:

• Keys - An array of primary key attribute values that define specific items in the table.

• ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.

• ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.

Class com.amazonaws.services.dynamodbv2.model.BatchWriteItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

requestItems

java.util.Map<java.lang.String,java.util.List<WriteRequest>> requestItems

A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:

• DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

  • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

• PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

  • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.

    If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

returnConsumedCapacity

java.lang.String returnConsumedCapacity

Determines the level of detail about provisioned throughput consumption that is returned in the response:

• INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

  Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

• TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

• NONE - No ConsumedCapacity details are included in the response.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

returnItemCollectionMetrics

java.lang.String returnItemCollectionMetrics

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Constraints:
Allowed Values: SIZE, NONE

Class com.amazonaws.services.dynamodbv2.model.BatchWriteItemResult extends java.lang.Object implements Serializable

Serialized Fields

consumedCapacity

java.util.List<ConsumedCapacity> consumedCapacity

The capacity units consumed by the entire BatchWriteItem operation.

Each element consists of:

• TableName - The table that consumed the provisioned throughput.

• CapacityUnits - The total number of capacity units consumed.

itemCollectionMetrics

java.util.Map<java.lang.String,java.util.List<ItemCollectionMetrics>> itemCollectionMetrics

A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations.

Each entry consists of the following subelements:

• ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item.

• SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.

  The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

unprocessedItems

java.util.Map<java.lang.String,java.util.List<WriteRequest>> unprocessedItems

A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform ( DeleteRequest or PutRequest).

• DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

  • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

• PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

  • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.

    If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.

Class com.amazonaws.services.dynamodbv2.model.Capacity extends java.lang.Object implements Serializable

Serialized Fields

capacityUnits

java.lang.Double capacityUnits

The total number of capacity units consumed on a table or an index.

Class com.amazonaws.services.dynamodbv2.model.Condition extends java.lang.Object implements Serializable

Serialized Fields

attributeValueList

java.util.List<AttributeValue> attributeValueList

One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

For type Number, value comparisons are numeric.

String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

comparisonOperator

java.lang.String comparisonOperator

A comparator for evaluating attributes. For example, equals, greater than, less than, etc.

The following comparison operators are available:

EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

The following are descriptions of each comparison operator.

• EQ : Equal. EQ is supported for all data types, including lists and maps.

  AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]} .

• NE : Not equal. NE is supported for all data types, including lists and maps.

  AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]} .

• LE : Less than or equal.

  AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

• LT : Less than.

  AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

• GE : Greater than or equal.

  AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

• GT : Greater than.

  AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

• NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.

  This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true . This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.

• NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.

  This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.

• CONTAINS : Checks for a subsequence, or value in a set.

  AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS ", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set.

  CONTAINS is supported for lists: When evaluating " a CONTAINS b", "a" can be a list; however, " b" cannot be a set, a map, or a list.

• NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.

  AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", " NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set.

  NOT_CONTAINS is supported for lists: When evaluating " a NOT CONTAINS b", "a " can be a list; however, "b" cannot be a set, a map, or a list.

• BEGINS_WITH : Checks for a prefix.

  AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).

• IN : Checks for matching elements in a list.

  AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.

• BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

  AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

Constraints:
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH

Class com.amazonaws.services.dynamodbv2.model.ConditionalCheckFailedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.ConsumedCapacity extends java.lang.Object implements Serializable

Serialized Fields

capacityUnits

java.lang.Double capacityUnits

The total number of capacity units consumed by the operation.

globalSecondaryIndexes

java.util.Map<java.lang.String,Capacity> globalSecondaryIndexes

The amount of throughput consumed on each global index affected by the operation.

localSecondaryIndexes

java.util.Map<java.lang.String,Capacity> localSecondaryIndexes

The amount of throughput consumed on each local index affected by the operation.

table

Capacity table

The amount of throughput consumed on the table affected by the operation.

tableName

java.lang.String tableName

The name of the table that was affected by the operation.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.ContinuousBackupsDescription extends java.lang.Object implements Serializable

Serialized Fields

continuousBackupsStatus

java.lang.String continuousBackupsStatus

ContinuousBackupsStatus can be one of the following states: ENABLED, DISABLED

Constraints:
Allowed Values: ENABLED, DISABLED

pointInTimeRecoveryDescription

PointInTimeRecoveryDescription pointInTimeRecoveryDescription

The description of the point in time recovery settings applied to the table.

Class com.amazonaws.services.dynamodbv2.model.ContinuousBackupsUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.CreateBackupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

backupName

java.lang.String backupName

Specified name for the backup.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

tableName

java.lang.String tableName

The name of the table.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.CreateBackupResult extends java.lang.Object implements Serializable

Serialized Fields

backupDetails

BackupDetails backupDetails

Contains the details of the backup created for the table.

Class com.amazonaws.services.dynamodbv2.model.CreateGlobalSecondaryIndexAction extends java.lang.Object implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The name of the global secondary index to be created.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

keySchema

java.util.List<KeySchemaElement> keySchema

The key schema for the global secondary index.

projection

Projection projection

Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

provisionedThroughput

ProvisionedThroughput provisionedThroughput

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

Class com.amazonaws.services.dynamodbv2.model.CreateGlobalTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

globalTableName

java.lang.String globalTableName

The global table name.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

replicationGroup

java.util.List<Replica> replicationGroup

The regions where the global table needs to be created.

Class com.amazonaws.services.dynamodbv2.model.CreateGlobalTableResult extends java.lang.Object implements Serializable

Serialized Fields

globalTableDescription

GlobalTableDescription globalTableDescription

Contains the details of the global table.

Class com.amazonaws.services.dynamodbv2.model.CreateReplicaAction extends java.lang.Object implements Serializable

Serialized Fields

regionName

java.lang.String regionName

The region of the replica to be added.

Class com.amazonaws.services.dynamodbv2.model.CreateTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeDefinitions

java.util.List<AttributeDefinition> attributeDefinitions

An array of attributes that describe the key schema for the table and indexes.

globalSecondaryIndexes

java.util.List<GlobalSecondaryIndex> globalSecondaryIndexes

One or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array includes the following:

• IndexName - The name of the global secondary index. Must be unique only for this table.

• KeySchema - Specifies the key schema for the global secondary index.

• Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

  • ProjectionType - One of the following:

    • KEYS_ONLY - Only the index and primary keys are projected into the index.

    • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

    • ALL - All of the table attributes are projected into the index.

  • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

• ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

keySchema

java.util.List<KeySchemaElement> keySchema

Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:

• AttributeName - The name of this key attribute.

• KeyType - The role that the key attribute will assume:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.

localSecondaryIndexes

java.util.List<LocalSecondaryIndex> localSecondaryIndexes

One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following:

• IndexName - The name of the local secondary index. Must be unique only for this table.

• KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.

• Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

  • ProjectionType - One of the following:

    • KEYS_ONLY - Only the index and primary keys are projected into the index.

    • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

    • ALL - All of the table attributes are projected into the index.

  • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

provisionedThroughput

ProvisionedThroughput provisionedThroughput

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

sSESpecification

SSESpecification sSESpecification

Represents the settings used to enable server-side encryption.

streamSpecification

StreamSpecification streamSpecification

The settings for DynamoDB Streams on the table. These settings consist of:

• StreamEnabled - Indicates whether Streams is to be enabled (true) or disabled (false).

• StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:

  • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

  • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

  • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

  • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

tableName

java.lang.String tableName

The name of the table to create.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.CreateTableResult extends java.lang.Object implements Serializable

Serialized Fields

tableDescription

TableDescription tableDescription

Represents the properties of the table.

Class com.amazonaws.services.dynamodbv2.model.DeleteBackupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

backupArn

java.lang.String backupArn

The ARN associated with the backup.

Constraints:
Length: 37 - 1024

Class com.amazonaws.services.dynamodbv2.model.DeleteBackupResult extends java.lang.Object implements Serializable

Serialized Fields

backupDescription

BackupDescription backupDescription

Contains the description of the backup created for the table.

Class com.amazonaws.services.dynamodbv2.model.DeleteGlobalSecondaryIndexAction extends java.lang.Object implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The name of the global secondary index to be deleted.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.DeleteItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

conditionalOperator

java.lang.String conditionalOperator

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Constraints:
Allowed Values: AND, OR

conditionExpression

java.lang.String conditionExpression

A condition that must be satisfied in order for a conditional DeleteItem to succeed.

An expression can contain any of the following:

• Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

  These function names are case-sensitive.

• Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

• Logical operators: AND | OR | NOT

For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

expected

java.util.Map<java.lang.String,ExpectedAttributeValue> expected

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

expressionAttributeNames

java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

• To access an attribute whose name conflicts with a DynamoDB reserved word.

• To create a placeholder for repeating occurrences of an attribute name in an expression.

• To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

• Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

• {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

• #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

expressionAttributeValues

java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

key

java.util.Map<java.lang.String,AttributeValue> key

A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

returnConsumedCapacity

java.lang.String returnConsumedCapacity

Determines the level of detail about provisioned throughput consumption that is returned in the response:

• INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

  Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

• TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

• NONE - No ConsumedCapacity details are included in the response.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

returnItemCollectionMetrics

java.lang.String returnItemCollectionMetrics

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Constraints:
Allowed Values: SIZE, NONE

returnValues

java.lang.String returnValues

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

• NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

• ALL_OLD - The content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

tableName

java.lang.String tableName

The name of the table from which to delete the item.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.DeleteItemResult extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,AttributeValue> attributes

A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

consumedCapacity

ConsumedCapacity consumedCapacity

The capacity units consumed by the DeleteItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

itemCollectionMetrics

ItemCollectionMetrics itemCollectionMetrics

Information about item collections, if any, that were affected by the DeleteItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

• ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

• SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

  The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

Class com.amazonaws.services.dynamodbv2.model.DeleteReplicaAction extends java.lang.Object implements Serializable

Serialized Fields

regionName

java.lang.String regionName

The region of the replica to be removed.

Class com.amazonaws.services.dynamodbv2.model.DeleteRequest extends java.lang.Object implements Serializable

Serialized Fields

key

java.util.Map<java.lang.String,AttributeValue> key

A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

Class com.amazonaws.services.dynamodbv2.model.DeleteTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

java.lang.String tableName

The name of the table to delete.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.DeleteTableResult extends java.lang.Object implements Serializable

Serialized Fields

tableDescription

TableDescription tableDescription

Represents the properties of a table.

Class com.amazonaws.services.dynamodbv2.model.DescribeBackupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

backupArn

java.lang.String backupArn

The ARN associated with the backup.

Constraints:
Length: 37 - 1024

Class com.amazonaws.services.dynamodbv2.model.DescribeBackupResult extends java.lang.Object implements Serializable

Serialized Fields

backupDescription

BackupDescription backupDescription

Contains the description of the backup created for the table.

Class com.amazonaws.services.dynamodbv2.model.DescribeContinuousBackupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

java.lang.String tableName

Name of the table for which the customer wants to check the continuous backups and point in time recovery settings.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.DescribeContinuousBackupsResult extends java.lang.Object implements Serializable

Serialized Fields

continuousBackupsDescription

ContinuousBackupsDescription continuousBackupsDescription

Represents the continuous backups and point in time recovery settings on the table.

Class com.amazonaws.services.dynamodbv2.model.DescribeEndpointsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.dynamodbv2.model.DescribeEndpointsResult extends java.lang.Object implements Serializable

Serialized Fields

endpoints

java.util.List<Endpoint> endpoints

The new value for the endpoints property for this object.

Class com.amazonaws.services.dynamodbv2.model.DescribeGlobalTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

globalTableName

java.lang.String globalTableName

The name of the global table.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.DescribeGlobalTableResult extends java.lang.Object implements Serializable

Serialized Fields

globalTableDescription

GlobalTableDescription globalTableDescription

Contains the details of the global table.

Class com.amazonaws.services.dynamodbv2.model.DescribeGlobalTableSettingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

globalTableName

java.lang.String globalTableName

The name of the global table to describe.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.DescribeGlobalTableSettingsResult extends java.lang.Object implements Serializable

Serialized Fields

globalTableName

java.lang.String globalTableName

The name of the global table.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

replicaSettings

java.util.List<ReplicaSettingsDescription> replicaSettings

The region specific settings for the global table.

Class com.amazonaws.services.dynamodbv2.model.DescribeLimitsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.dynamodbv2.model.DescribeLimitsResult extends java.lang.Object implements Serializable

Serialized Fields

accountMaxReadCapacityUnits

java.lang.Long accountMaxReadCapacityUnits

The maximum total read capacity units that your account allows you to provision across all of your tables in this region.

Constraints:
Range: 1 -

accountMaxWriteCapacityUnits

java.lang.Long accountMaxWriteCapacityUnits

The maximum total write capacity units that your account allows you to provision across all of your tables in this region.

Constraints:
Range: 1 -

tableMaxReadCapacityUnits

java.lang.Long tableMaxReadCapacityUnits

The maximum read capacity units that your account allows you to provision for a new table that you are creating in this region, including the read capacity units provisioned for its global secondary indexes (GSIs).

Constraints:
Range: 1 -

tableMaxWriteCapacityUnits

java.lang.Long tableMaxWriteCapacityUnits

The maximum write capacity units that your account allows you to provision for a new table that you are creating in this region, including the write capacity units provisioned for its global secondary indexes (GSIs).

Constraints:
Range: 1 -

Class com.amazonaws.services.dynamodbv2.model.DescribeTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

java.lang.String tableName

The name of the table to describe.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.DescribeTableResult extends java.lang.Object implements Serializable

Serialized Fields

table

TableDescription table

The properties of the table.

Class com.amazonaws.services.dynamodbv2.model.DescribeTimeToLiveRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

java.lang.String tableName

The name of the table to be described.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.DescribeTimeToLiveResult extends java.lang.Object implements Serializable

Serialized Fields

timeToLiveDescription

TimeToLiveDescription timeToLiveDescription

Class com.amazonaws.services.dynamodbv2.model.Endpoint extends java.lang.Object implements Serializable

Serialized Fields

address

java.lang.String address

The new value for the address property for this object.

cachePeriodInMinutes

java.lang.Long cachePeriodInMinutes

The new value for the cachePeriodInMinutes property for this object.

Class com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue extends java.lang.Object implements Serializable

Serialized Fields

attributeValueList

java.util.List<AttributeValue> attributeValueList

One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

For type Number, value comparisons are numeric.

String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.

comparisonOperator

java.lang.String comparisonOperator

A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc.

The following comparison operators are available:

EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

The following are descriptions of each comparison operator.

• EQ : Equal. EQ is supported for all data types, including lists and maps.

  AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]} .

• NE : Not equal. NE is supported for all data types, including lists and maps.

  AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]} .

• LE : Less than or equal.

  AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

• LT : Less than.

  AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

• GE : Greater than or equal.

  AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

• GT : Greater than.

  AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.

• NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.

  This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true . This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.

• NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.

  This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.

• CONTAINS : Checks for a subsequence, or value in a set.

  AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS ", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set.

  CONTAINS is supported for lists: When evaluating " a CONTAINS b", "a" can be a list; however, " b" cannot be a set, a map, or a list.

• NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.

  AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", " NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set.

  NOT_CONTAINS is supported for lists: When evaluating " a NOT CONTAINS b", "a " can be a list; however, "b" cannot be a set, a map, or a list.

• BEGINS_WITH : Checks for a prefix.

  AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).

• IN : Checks for matching elements in a list.

  AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.

• BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

  AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}

Constraints:
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH

exists

java.lang.Boolean exists

Causes DynamoDB to evaluate the value before attempting a conditional operation:

• If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionalCheckFailedException.

• If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionalCheckFailedException.

The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

DynamoDB returns a ValidationException if:

• Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

• Exists is false but you also provide a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

value

AttributeValue value

Represents the data for the expected attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

Class com.amazonaws.services.dynamodbv2.model.GetItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributesToGet

java.util.List<java.lang.String> attributesToGet

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

consistentRead

java.lang.Boolean consistentRead

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

expressionAttributeNames

java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

• To access an attribute whose name conflicts with a DynamoDB reserved word.

• To create a placeholder for repeating occurrences of an attribute name in an expression.

• To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

• Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

• {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

• #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

key

java.util.Map<java.lang.String,AttributeValue> key

A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

projectionExpression

java.lang.String projectionExpression

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

returnConsumedCapacity

java.lang.String returnConsumedCapacity

Determines the level of detail about provisioned throughput consumption that is returned in the response:

• INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

  Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

• TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

• NONE - No ConsumedCapacity details are included in the response.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

tableName

java.lang.String tableName

The name of the table containing the requested item.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.GetItemResult extends java.lang.Object implements Serializable

Serialized Fields

consumedCapacity

ConsumedCapacity consumedCapacity

The capacity units consumed by the GetItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

item

java.util.Map<java.lang.String,AttributeValue> item

A map of attribute names to AttributeValue objects, as specified by ProjectionExpression.

Class com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndex extends java.lang.Object implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The name of the global secondary index. The name must be unique among all other indexes on this table.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

keySchema

java.util.List<KeySchemaElement> keySchema

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

• HASH - partition key

• RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

projection

Projection projection

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

provisionedThroughput

ProvisionedThroughput provisionedThroughput

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

Class com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexDescription extends java.lang.Object implements Serializable

Serialized Fields

backfilling

java.lang.Boolean backfilling

Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.

indexArn

java.lang.String indexArn

The Amazon Resource Name (ARN) that uniquely identifies the index.

indexName

java.lang.String indexName

The name of the global secondary index.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

indexSizeBytes

java.lang.Long indexSizeBytes

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

indexStatus

java.lang.String indexStatus

The current state of the global secondary index:

• CREATING - The index is being created.

• UPDATING - The index is being updated.

• DELETING - The index is being deleted.

• ACTIVE - The index is ready for use.

Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE

itemCount

java.lang.Long itemCount

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

keySchema

java.util.List<KeySchemaElement> keySchema

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

• HASH - partition key

• RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

projection

Projection projection

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

provisionedThroughput

ProvisionedThroughputDescription provisionedThroughput

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

Class com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexInfo extends java.lang.Object implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The name of the global secondary index.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

keySchema

java.util.List<KeySchemaElement> keySchema

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

• HASH - partition key

• RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

projection

Projection projection

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

provisionedThroughput

ProvisionedThroughput provisionedThroughput

Represents the provisioned throughput settings for the specified global secondary index.

Class com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexUpdate extends java.lang.Object implements Serializable

Serialized Fields

create

CreateGlobalSecondaryIndexAction create

The parameters required for creating a global secondary index on an existing table:

• IndexName

• KeySchema

• AttributeDefinitions

• Projection

• ProvisionedThroughput

delete

DeleteGlobalSecondaryIndexAction delete

The name of an existing global secondary index to be removed.

update

UpdateGlobalSecondaryIndexAction update

The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

Class com.amazonaws.services.dynamodbv2.model.GlobalTable extends java.lang.Object implements Serializable

Serialized Fields

globalTableName

java.lang.String globalTableName

The global table name.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

replicationGroup

java.util.List<Replica> replicationGroup

The regions where the global table has replicas.

Class com.amazonaws.services.dynamodbv2.model.GlobalTableAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.GlobalTableDescription extends java.lang.Object implements Serializable

Serialized Fields

creationDateTime

java.util.Date creationDateTime

The creation time of the global table.

globalTableArn

java.lang.String globalTableArn

The unique identifier of the global table.

globalTableName

java.lang.String globalTableName

The global table name.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

globalTableStatus

java.lang.String globalTableStatus

The current state of the global table:

• CREATING - The global table is being created.

• UPDATING - The global table is being updated.

• DELETING - The global table is being deleted.

• ACTIVE - The global table is ready for use.

Constraints:
Allowed Values: CREATING, ACTIVE, DELETING, UPDATING

replicationGroup

java.util.List<ReplicaDescription> replicationGroup

The regions where the global table has replicas.

Class com.amazonaws.services.dynamodbv2.model.GlobalTableGlobalSecondaryIndexSettingsUpdate extends java.lang.Object implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The name of the global secondary index. The name must be unique among all other indexes on this table.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

provisionedWriteCapacityAutoScalingSettingsUpdate

AutoScalingSettingsUpdate provisionedWriteCapacityAutoScalingSettingsUpdate

AutoScaling settings for managing a global secondary index's write capacity units.

provisionedWriteCapacityUnits

java.lang.Long provisionedWriteCapacityUnits

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

Constraints:
Range: 1 -

Class com.amazonaws.services.dynamodbv2.model.GlobalTableNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.IndexNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.InternalServerErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.InvalidRestoreTimeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.ItemCollectionMetrics extends java.lang.Object implements Serializable

Serialized Fields

itemCollectionKey

java.util.Map<java.lang.String,AttributeValue> itemCollectionKey

The partition key value of the item collection. This value is the same as the partition key value of the item.

sizeEstimateRangeGB

java.util.List<java.lang.Double> sizeEstimateRangeGB

An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

Class com.amazonaws.services.dynamodbv2.model.ItemCollectionSizeLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.KeysAndAttributes extends java.lang.Object implements Serializable

Serialized Fields

attributesToGet

java.util.List<java.lang.String> attributesToGet

This is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

consistentRead

java.lang.Boolean consistentRead

The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

expressionAttributeNames

java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

• To access an attribute whose name conflicts with a DynamoDB reserved word.

• To create a placeholder for repeating occurrences of an attribute name in an expression.

• To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

• Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

• {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

• #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

keys

java.util.List<java.util.Map<java.lang.String,AttributeValue>> keys

The primary key attribute values that define the items and the attributes associated with the items.

projectionExpression

java.lang.String projectionExpression

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

Class com.amazonaws.services.dynamodbv2.model.KeySchemaElement extends java.lang.Object implements Serializable

Serialized Fields

attributeName

java.lang.String attributeName

The name of a key attribute.

Constraints:
Length: 1 - 255

keyType

java.lang.String keyType

The role that this key attribute will assume:

• HASH - partition key

• RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

Constraints:
Allowed Values: HASH, RANGE

Class com.amazonaws.services.dynamodbv2.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.ListBackupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

backupType

java.lang.String backupType

The backups from the table specified by BackupType are listed.

Where BackupType can be:

• USER - On-demand backup created by you.

• SYSTEM - On-demand backup automatically created by DynamoDB.

• ALL - All types of on-demand backups (USER and SYSTEM).

Constraints:
Allowed Values: USER, SYSTEM, ALL

exclusiveStartBackupArn

java.lang.String exclusiveStartBackupArn

LastEvaluatedBackupArn is the ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

Constraints:
Length: 37 - 1024

limit

java.lang.Integer limit

Maximum number of backups to return at once.

Constraints:
Range: 1 - 100

tableName

java.lang.String tableName

The backups from the table specified by TableName are listed.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

timeRangeLowerBound

java.util.Date timeRangeLowerBound

Only backups created after this time are listed. TimeRangeLowerBound is inclusive.

timeRangeUpperBound

java.util.Date timeRangeUpperBound

Only backups created before this time are listed. TimeRangeUpperBound is exclusive.

Class com.amazonaws.services.dynamodbv2.model.ListBackupsResult extends java.lang.Object implements Serializable

Serialized Fields

backupSummaries

java.util.List<BackupSummary> backupSummaries

List of BackupSummary objects.

lastEvaluatedBackupArn

java.lang.String lastEvaluatedBackupArn

The ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

If LastEvaluatedBackupArn is empty, then the last page of results has been processed and there are no more results to be retrieved.

If LastEvaluatedBackupArn is not empty, this may or may not indicate there is more data to be returned. All results are guaranteed to have been returned if and only if no value for LastEvaluatedBackupArn is returned.

Constraints:
Length: 37 - 1024

Class com.amazonaws.services.dynamodbv2.model.ListGlobalTablesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exclusiveStartGlobalTableName

java.lang.String exclusiveStartGlobalTableName

The first global table name that this operation will evaluate.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

limit

java.lang.Integer limit

The maximum number of table names to return.

Constraints:
Range: 1 -

regionName

java.lang.String regionName

Lists the global tables in a specific region.

Class com.amazonaws.services.dynamodbv2.model.ListGlobalTablesResult extends java.lang.Object implements Serializable

Serialized Fields

globalTables

java.util.List<GlobalTable> globalTables

List of global table names.

lastEvaluatedGlobalTableName

java.lang.String lastEvaluatedGlobalTableName

Last evaluated global table name.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.ListTablesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exclusiveStartTableName

java.lang.String exclusiveStartTableName

The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

limit

java.lang.Integer limit

A maximum number of table names to return. If this parameter is not specified, the limit is 100.

Constraints:
Range: 1 - 100

Class com.amazonaws.services.dynamodbv2.model.ListTablesResult extends java.lang.Object implements Serializable

Serialized Fields

lastEvaluatedTableName

java.lang.String lastEvaluatedTableName

The name of the last table in the current page of results. Use this value as the ExclusiveStartTableName in a new request to obtain the next page of results, until all the table names are returned.

If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

tableNames

java.util.List<java.lang.String> tableNames

The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.

If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.

Class com.amazonaws.services.dynamodbv2.model.ListTagsOfResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

An optional string that, if supplied, must be copied from the output of a previous call to ListTagOfResource. When provided in this manner, this API fetches the next page of results.

resourceArn

java.lang.String resourceArn

The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

Constraints:
Length: 1 - 1283

Class com.amazonaws.services.dynamodbv2.model.ListTagsOfResourceResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If this value is returned, there are additional results to be displayed. To retrieve them, call ListTagsOfResource again, with NextToken set to this value.

tags

java.util.List<Tag> tags

The tags currently associated with the Amazon DynamoDB resource.

Class com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndex extends java.lang.Object implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The name of the local secondary index. The name must be unique among all other indexes on this table.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

keySchema

java.util.List<KeySchemaElement> keySchema

The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

• HASH - partition key

• RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

projection

Projection projection

Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Class com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndexDescription extends java.lang.Object implements Serializable

Serialized Fields

indexArn

java.lang.String indexArn

The Amazon Resource Name (ARN) that uniquely identifies the index.

indexName

java.lang.String indexName

Represents the name of the local secondary index.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

indexSizeBytes

java.lang.Long indexSizeBytes

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

itemCount

java.lang.Long itemCount

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

keySchema

java.util.List<KeySchemaElement> keySchema

The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

• HASH - partition key

• RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

projection

Projection projection

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Class com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndexInfo extends java.lang.Object implements Serializable

Serialized Fields

indexName

java.lang.String indexName

Represents the name of the local secondary index.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

keySchema

java.util.List<KeySchemaElement> keySchema

The complete key schema for a local secondary index, which consists of one or more pairs of attribute names and key types:

• HASH - partition key

• RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

projection

Projection projection

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Class com.amazonaws.services.dynamodbv2.model.PointInTimeRecoveryDescription extends java.lang.Object implements Serializable

Serialized Fields

earliestRestorableDateTime

java.util.Date earliestRestorableDateTime

Specifies the earliest point in time you can restore your table to. It You can restore your table to any point in time during the last 35 days.

latestRestorableDateTime

java.util.Date latestRestorableDateTime

LatestRestorableDateTime is typically 5 minutes before the current time.

pointInTimeRecoveryStatus

java.lang.String pointInTimeRecoveryStatus

The current state of point in time recovery:

• ENABLING - Point in time recovery is being enabled.

• ENABLED - Point in time recovery is enabled.

• DISABLED - Point in time recovery is disabled.

Constraints:
Allowed Values: ENABLED, DISABLED

Class com.amazonaws.services.dynamodbv2.model.PointInTimeRecoverySpecification extends java.lang.Object implements Serializable

Serialized Fields

pointInTimeRecoveryEnabled

java.lang.Boolean pointInTimeRecoveryEnabled

Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.

Class com.amazonaws.services.dynamodbv2.model.PointInTimeRecoveryUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.Projection extends java.lang.Object implements Serializable

Serialized Fields

nonKeyAttributes

java.util.List<java.lang.String> nonKeyAttributes

Represents the non-key attribute names which will be projected into the index.

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

projectionType

java.lang.String projectionType

The set of attributes that are projected into the index:

• KEYS_ONLY - Only the index and primary keys are projected into the index.

• INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

• ALL - All of the table attributes are projected into the index.

Constraints:
Allowed Values: ALL, KEYS_ONLY, INCLUDE

Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput extends java.lang.Object implements Serializable

Serialized Fields

readCapacityUnits

java.lang.Long readCapacityUnits

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

Constraints:
Range: 1 -

writeCapacityUnits

java.lang.Long writeCapacityUnits

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

Constraints:
Range: 1 -

Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughputDescription extends java.lang.Object implements Serializable

Serialized Fields

lastDecreaseDateTime

java.util.Date lastDecreaseDateTime

The date and time of the last provisioned throughput decrease for this table.

lastIncreaseDateTime

java.util.Date lastIncreaseDateTime

The date and time of the last provisioned throughput increase for this table.

numberOfDecreasesToday

java.lang.Long numberOfDecreasesToday

The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

Constraints:
Range: 1 -

readCapacityUnits

java.lang.Long readCapacityUnits

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

Constraints:
Range: 1 -

writeCapacityUnits

java.lang.Long writeCapacityUnits

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

Constraints:
Range: 1 -

Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughputExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.PutItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

conditionalOperator

java.lang.String conditionalOperator

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Constraints:
Allowed Values: AND, OR

conditionExpression

java.lang.String conditionExpression

A condition that must be satisfied in order for a conditional PutItem operation to succeed.

An expression can contain any of the following:

• Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

  These function names are case-sensitive.

• Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

• Logical operators: AND | OR | NOT

For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

expected

java.util.Map<java.lang.String,ExpectedAttributeValue> expected

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

expressionAttributeNames

java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

• To access an attribute whose name conflicts with a DynamoDB reserved word.

• To create a placeholder for repeating occurrences of an attribute name in an expression.

• To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

• Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

• {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

• #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

expressionAttributeValues

java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

item

java.util.Map<java.lang.String,AttributeValue> item

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

returnConsumedCapacity

java.lang.String returnConsumedCapacity

Determines the level of detail about provisioned throughput consumption that is returned in the response:

• INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

  Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

• TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

• NONE - No ConsumedCapacity details are included in the response.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

returnItemCollectionMetrics

java.lang.String returnItemCollectionMetrics

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Constraints:
Allowed Values: SIZE, NONE

returnValues

java.lang.String returnValues

Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:

• NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

• ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

tableName

java.lang.String tableName

The name of the table to contain the item.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.PutItemResult extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,AttributeValue> attributes

The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.

consumedCapacity

ConsumedCapacity consumedCapacity

The capacity units consumed by the PutItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

itemCollectionMetrics

ItemCollectionMetrics itemCollectionMetrics

Information about item collections, if any, that were affected by the PutItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

• ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

• SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

  The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

Class com.amazonaws.services.dynamodbv2.model.PutRequest extends java.lang.Object implements Serializable

Serialized Fields

item

java.util.Map<java.lang.String,AttributeValue> item

A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema.

Class com.amazonaws.services.dynamodbv2.model.QueryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributesToGet

java.util.List<java.lang.String> attributesToGet

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

conditionalOperator

java.lang.String conditionalOperator

This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Constraints:
Allowed Values: AND, OR

consistentRead

java.lang.Boolean consistentRead

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

exclusiveStartKey

java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

expressionAttributeNames

java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

• To access an attribute whose name conflicts with a DynamoDB reserved word.

• To create a placeholder for repeating occurrences of an attribute name in an expression.

• To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

• Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

• {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

• #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

expressionAttributeValues

java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

filterExpression

java.lang.String filterExpression

A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression does not allow key attributes. You cannot define a filter expression based on a partition key or a sort key.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

indexName

java.lang.String indexName

The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that if you use the IndexName parameter, you must also provide TableName.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

keyConditionExpression

java.lang.String keyConditionExpression

The condition that specifies the key value(s) for items to be retrieved by the Query action.

The condition must perform an equality test on a single partition key value.

The condition can optionally perform one of several comparison tests on a single sort key value. This allows Query to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.

The partition key equality test is required, and must be specified in the following format:

partitionKeyName = :partitionkeyval

If you also want to provide a condition for the sort key, it must be combined using AND with the condition for the sort key. Following is an example, using the = comparison operator for the sort key:

partitionKeyName = :partitionkeyval AND sortKeyName = :sortkeyval

Valid comparisons for the sort key condition are as follows:

• sortKeyName = :sortkeyval - true if the sort key value is equal to :sortkeyval.

• sortKeyName < :sortkeyval - true if the sort key value is less than :sortkeyval.

• sortKeyName <= :sortkeyval - true if the sort key value is less than or equal to :sortkeyval.

• sortKeyName > :sortkeyval - true if the sort key value is greater than :sortkeyval.

• sortKeyName >= :sortkeyval - true if the sort key value is greater than or equal to :sortkeyval.

• sortKeyName BETWEEN :sortkeyval1 AND :sortkeyval2 - true if the sort key value is greater than or equal to :sortkeyval1, and less than or equal to :sortkeyval2.

• begins_with ( sortKeyName, :sortkeyval ) - true if the sort key value begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note that the function name begins_with is case-sensitive.

Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval and :sortval with actual values at runtime.

You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word:

• Size = :myval

To work around this, define a placeholder (such a #S) to represent the attribute name Size. KeyConditionExpression then is as follows:

• #S = :myval

For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.

For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.

keyConditions

java.util.Map<java.lang.String,Condition> keyConditions

This is a legacy parameter. Use KeyConditionExpression instead. For more information, see KeyConditions in the Amazon DynamoDB Developer Guide.

limit

java.lang.Integer limit

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.

Constraints:
Range: 1 -

projectionExpression

java.lang.String projectionExpression

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

queryFilter

java.util.Map<java.lang.String,Condition> queryFilter

This is a legacy parameter. Use FilterExpression instead. For more information, see QueryFilter in the Amazon DynamoDB Developer Guide.

returnConsumedCapacity

java.lang.String returnConsumedCapacity

Determines the level of detail about provisioned throughput consumption that is returned in the response:

• INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

  Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

• TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

• NONE - No ConsumedCapacity details are included in the response.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

scanIndexForward

java.lang.Boolean scanIndexForward

Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order.

Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned.

If ScanIndexForward is true, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If ScanIndexForward is false, DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.

select

java.lang.String select

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

• ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

• ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.

• COUNT - Returns the number of matching items, rather than the matching items themselves.

• SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.

  If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

  If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.

Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT

tableName

java.lang.String tableName

The name of the table containing the requested items.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.QueryResult extends java.lang.Object implements Serializable

Serialized Fields

consumedCapacity

ConsumedCapacity consumedCapacity

The capacity units consumed by the Query operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

count

java.lang.Integer count

The number of items in the response.

If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

If you did not use a filter in the request, then Count and ScannedCount are the same.

items

java.util.List<java.util.Map<java.lang.String,AttributeValue>> items

An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.

lastEvaluatedKey

java.util.Map<java.lang.String,AttributeValue> lastEvaluatedKey

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

scannedCount

java.lang.Integer scannedCount

The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

Class com.amazonaws.services.dynamodbv2.model.Replica extends java.lang.Object implements Serializable

Serialized Fields

regionName

java.lang.String regionName

The region where the replica needs to be created.

Class com.amazonaws.services.dynamodbv2.model.ReplicaAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.ReplicaDescription extends java.lang.Object implements Serializable

Serialized Fields

regionName

java.lang.String regionName

The name of the region.

Class com.amazonaws.services.dynamodbv2.model.ReplicaGlobalSecondaryIndexSettingsDescription extends java.lang.Object implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The name of the global secondary index. The name must be unique among all other indexes on this table.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

indexStatus

java.lang.String indexStatus

The current status of the global secondary index:

• CREATING - The global secondary index is being created.

• UPDATING - The global secondary index is being updated.

• DELETING - The global secondary index is being deleted.

• ACTIVE - The global secondary index is ready for use.

Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE

provisionedReadCapacityAutoScalingSettings

AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings

Autoscaling settings for a global secondary index replica's read capacity units.

provisionedReadCapacityUnits

java.lang.Long provisionedReadCapacityUnits

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

Constraints:
Range: 1 -

provisionedWriteCapacityAutoScalingSettings

AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings

AutoScaling settings for a global secondary index replica's write capacity units.

provisionedWriteCapacityUnits

java.lang.Long provisionedWriteCapacityUnits

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

Constraints:
Range: 1 -

Class com.amazonaws.services.dynamodbv2.model.ReplicaGlobalSecondaryIndexSettingsUpdate extends java.lang.Object implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The name of the global secondary index. The name must be unique among all other indexes on this table.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

provisionedReadCapacityAutoScalingSettingsUpdate

AutoScalingSettingsUpdate provisionedReadCapacityAutoScalingSettingsUpdate

Autoscaling settings for managing a global secondary index replica's read capacity units.

provisionedReadCapacityUnits

java.lang.Long provisionedReadCapacityUnits

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

Constraints:
Range: 1 -

Class com.amazonaws.services.dynamodbv2.model.ReplicaNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.ReplicaSettingsDescription extends java.lang.Object implements Serializable

Serialized Fields

regionName

java.lang.String regionName

The region name of the replica.

replicaGlobalSecondaryIndexSettings

java.util.List<ReplicaGlobalSecondaryIndexSettingsDescription> replicaGlobalSecondaryIndexSettings

Replica global secondary index settings for the global table.

replicaProvisionedReadCapacityAutoScalingSettings

AutoScalingSettingsDescription replicaProvisionedReadCapacityAutoScalingSettings

Autoscaling settings for a global table replica's read capacity units.

replicaProvisionedReadCapacityUnits

java.lang.Long replicaProvisionedReadCapacityUnits

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

Constraints:
Range: 1 -

replicaProvisionedWriteCapacityAutoScalingSettings

AutoScalingSettingsDescription replicaProvisionedWriteCapacityAutoScalingSettings

AutoScaling settings for a global table replica's write capacity units.

replicaProvisionedWriteCapacityUnits

java.lang.Long replicaProvisionedWriteCapacityUnits

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

Constraints:
Range: 1 -

replicaStatus

java.lang.String replicaStatus

The current state of the region:

• CREATING - The region is being created.

• UPDATING - The region is being updated.

• DELETING - The region is being deleted.

• ACTIVE - The region is ready for use.

Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE

Class com.amazonaws.services.dynamodbv2.model.ReplicaSettingsUpdate extends java.lang.Object implements Serializable

Serialized Fields

regionName

java.lang.String regionName

The region of the replica to be added.

replicaGlobalSecondaryIndexSettingsUpdate

java.util.List<ReplicaGlobalSecondaryIndexSettingsUpdate> replicaGlobalSecondaryIndexSettingsUpdate

Represents the settings of a global secondary index for a global table that will be modified.

replicaProvisionedReadCapacityAutoScalingSettingsUpdate

AutoScalingSettingsUpdate replicaProvisionedReadCapacityAutoScalingSettingsUpdate

Autoscaling settings for managing a global table replica's read capacity units.

replicaProvisionedReadCapacityUnits

java.lang.Long replicaProvisionedReadCapacityUnits

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

Constraints:
Range: 1 -

Class com.amazonaws.services.dynamodbv2.model.ReplicaUpdate extends java.lang.Object implements Serializable

Serialized Fields

create

CreateReplicaAction create

The parameters required for creating a replica on an existing global table.

delete

DeleteReplicaAction delete

The name of the existing replica to be removed.

Class com.amazonaws.services.dynamodbv2.model.ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.RestoreSummary extends java.lang.Object implements Serializable

Serialized Fields

restoreDateTime

java.util.Date restoreDateTime

Point in time or source backup time.

restoreInProgress

java.lang.Boolean restoreInProgress

Indicates if a restore is in progress or not.

sourceBackupArn

java.lang.String sourceBackupArn

ARN of the backup from which the table was restored.

Constraints:
Length: 37 - 1024

sourceTableArn

java.lang.String sourceTableArn

ARN of the source table of the backup that is being restored.

Class com.amazonaws.services.dynamodbv2.model.RestoreTableFromBackupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

backupArn

java.lang.String backupArn

The ARN associated with the backup.

Constraints:
Length: 37 - 1024

targetTableName

java.lang.String targetTableName

The name of the new table to which the backup must be restored.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.RestoreTableFromBackupResult extends java.lang.Object implements Serializable

Serialized Fields

tableDescription

TableDescription tableDescription

The description of the table created from an existing backup.

Class com.amazonaws.services.dynamodbv2.model.RestoreTableToPointInTimeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

restoreDateTime

java.util.Date restoreDateTime

Time in the past to restore the table to.

sourceTableName

java.lang.String sourceTableName

Name of the source table that is being restored.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

targetTableName

java.lang.String targetTableName

The name of the new table to which it must be restored to.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

useLatestRestorableTime

java.lang.Boolean useLatestRestorableTime

Restore the table to the latest possible time. LatestRestorableDateTime is typically 5 minutes before the current time.

Class com.amazonaws.services.dynamodbv2.model.RestoreTableToPointInTimeResult extends java.lang.Object implements Serializable

Serialized Fields

tableDescription

TableDescription tableDescription

Represents the properties of a table.

Class com.amazonaws.services.dynamodbv2.model.ScanRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributesToGet

java.util.List<java.lang.String> attributesToGet

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

conditionalOperator

java.lang.String conditionalOperator

This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Constraints:
Allowed Values: AND, OR

consistentRead

java.lang.Boolean consistentRead

A Boolean value that determines the read consistency model during the scan:

• If ConsistentRead is false, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem).

• If ConsistentRead is true, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.

The default setting for ConsistentRead is false .

The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

exclusiveStartKey

java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

expressionAttributeNames

java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

• To access an attribute whose name conflicts with a DynamoDB reserved word.

• To create a placeholder for repeating occurrences of an attribute name in an expression.

• To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

• Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

• {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

• #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

expressionAttributeValues

java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

filterExpression

java.lang.String filterExpression

A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

indexName

java.lang.String indexName

The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

limit

java.lang.Integer limit

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.

Constraints:
Range: 1 -

projectionExpression

java.lang.String projectionExpression

A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

returnConsumedCapacity

java.lang.String returnConsumedCapacity

Determines the level of detail about provisioned throughput consumption that is returned in the response:

• INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

  Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

• TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

• NONE - No ConsumedCapacity details are included in the response.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

scanFilter

java.util.Map<java.lang.String,Condition> scanFilter

This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.

segment

java.lang.Integer segment

For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.

Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.

The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.

The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.

If you provide Segment, you must also provide TotalSegments.

Constraints:
Range: 0 - 999999

select

java.lang.String select

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

• ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

• ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.

• COUNT - Returns the number of matching items, rather than the matching items themselves.

• SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.

  If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

  If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.

Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT

tableName

java.lang.String tableName

The name of the table containing the requested items; or, if you provide IndexName, the name of the table to which that index belongs.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

totalSegments

java.lang.Integer totalSegments

For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.

The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.

If you specify TotalSegments, you must also specify Segment.

Constraints:
Range: 1 - 1000000

Class com.amazonaws.services.dynamodbv2.model.ScanResult extends java.lang.Object implements Serializable

Serialized Fields

consumedCapacity

ConsumedCapacity consumedCapacity

The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

count

java.lang.Integer count

The number of items in the response.

If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

If you did not use a filter in the request, then Count is the same as ScannedCount.

items

java.util.List<java.util.Map<java.lang.String,AttributeValue>> items

An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

lastEvaluatedKey

java.util.Map<java.lang.String,AttributeValue> lastEvaluatedKey

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

scannedCount

java.lang.Integer scannedCount

The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

Class com.amazonaws.services.dynamodbv2.model.SourceTableDetails extends java.lang.Object implements Serializable

Serialized Fields

itemCount

java.lang.Long itemCount

Number of items in the table. Please note this is an approximate value.

Constraints:
Range: 0 -

keySchema

java.util.List<KeySchemaElement> keySchema

Schema of the table.

provisionedThroughput

ProvisionedThroughput provisionedThroughput

Read IOPs and Write IOPS on the table when the backup was created.

tableArn

java.lang.String tableArn

ARN of the table for which backup was created.

tableCreationDateTime

java.util.Date tableCreationDateTime

Time when the source table was created.

tableId

java.lang.String tableId

Unique identifier for the table for which the backup was created.

Constraints:
Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

tableName

java.lang.String tableName

The name of the table for which the backup was created.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

tableSizeBytes

java.lang.Long tableSizeBytes

Size of the table in bytes. Please note this is an approximate value.

Class com.amazonaws.services.dynamodbv2.model.SourceTableFeatureDetails extends java.lang.Object implements Serializable

Serialized Fields

globalSecondaryIndexes

java.util.List<GlobalSecondaryIndexInfo> globalSecondaryIndexes

Represents the GSI properties for the table when the backup was created. It includes the IndexName, KeySchema, Projection and ProvisionedThroughput for the GSIs on the table at the time of backup.

localSecondaryIndexes

java.util.List<LocalSecondaryIndexInfo> localSecondaryIndexes

Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.

sSEDescription

SSEDescription sSEDescription

The description of the server-side encryption status on the table when the backup was created.

streamDescription

StreamSpecification streamDescription

Stream settings on the table when the backup was created.

timeToLiveDescription

TimeToLiveDescription timeToLiveDescription

Time to Live settings on the table when the backup was created.

Class com.amazonaws.services.dynamodbv2.model.SSEDescription extends java.lang.Object implements Serializable

Serialized Fields

kMSMasterKeyArn

java.lang.String kMSMasterKeyArn

The KMS master key ARN used for the KMS encryption.

sSEType

java.lang.String sSEType

Server-side encryption type:

• AES256 - Server-side encryption which uses the AES256 algorithm.

• KMS - Server-side encryption which uses AWS Key Management Service.

Constraints:
Allowed Values: AES256, KMS

status

java.lang.String status

The current state of server-side encryption:

• ENABLING - Server-side encryption is being enabled.

• ENABLED - Server-side encryption is enabled.

• DISABLING - Server-side encryption is being disabled.

• DISABLED - Server-side encryption is disabled.

• UPDATING - Server-side encryption is being updated.

Constraints:
Allowed Values: ENABLING, ENABLED, DISABLING, DISABLED, UPDATING

Class com.amazonaws.services.dynamodbv2.model.SSESpecification extends java.lang.Object implements Serializable

Serialized Fields

enabled

java.lang.Boolean enabled

Indicates whether server-side encryption is enabled (true) or disabled (false) on the table.

kMSMasterKeyId

java.lang.String kMSMasterKeyId

The KMS Master Key (CMK) which should be used for the KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB KMS Master Key alias/aws/dynamodb.

sSEType

java.lang.String sSEType

Server-side encryption type:

• AES256 - Server-side encryption which uses the AES256 algorithm.

• KMS - Server-side encryption which uses AWS Key Management Service. (default)

Constraints:
Allowed Values: AES256, KMS

Class com.amazonaws.services.dynamodbv2.model.StreamSpecification extends java.lang.Object implements Serializable

Serialized Fields

streamEnabled

java.lang.Boolean streamEnabled

Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

streamViewType

java.lang.String streamViewType

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

• KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

• NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

• OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

• NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

Constraints:
Allowed Values: NEW_IMAGE, OLD_IMAGE, NEW_AND_OLD_IMAGES, KEYS_ONLY

Class com.amazonaws.services.dynamodbv2.model.TableAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.TableDescription extends java.lang.Object implements Serializable

Serialized Fields

attributeDefinitions

java.util.List<AttributeDefinition> attributeDefinitions

An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

Each AttributeDefinition object in this array is composed of:

• AttributeName - The name of the attribute.

• AttributeType - The data type for the attribute.

creationDateTime

java.util.Date creationDateTime

The date and time when the table was created, in UNIX epoch time format.

globalSecondaryIndexes

java.util.List<GlobalSecondaryIndexDescription> globalSecondaryIndexes

The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

• Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)

• IndexName - The name of the global secondary index.

• IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

• IndexStatus - The current status of the global secondary index:

  • CREATING - The index is being created.

  • UPDATING - The index is being updated.

  • DELETING - The index is being deleted.

  • ACTIVE - The index is ready for use.

• ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

• KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

• Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

  • ProjectionType - One of the following:

    • KEYS_ONLY - Only the index and primary keys are projected into the index.

    • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

    • ALL - All of the table attributes are projected into the index.

  • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

• ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.

If the table is in the DELETING state, no information about indexes will be returned.

itemCount

java.lang.Long itemCount

The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

keySchema

java.util.List<KeySchemaElement> keySchema

The primary key structure for the table. Each KeySchemaElement consists of:

• AttributeName - The name of the attribute.

• KeyType - The role of the attribute:

  • HASH - partition key

  • RANGE - sort key

  The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

  The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

latestStreamArn

java.lang.String latestStreamArn

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

Constraints:
Length: 37 - 1024

latestStreamLabel

java.lang.String latestStreamLabel

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

• the AWS customer ID.

• the table name.

• the StreamLabel.

localSecondaryIndexes

java.util.List<LocalSecondaryIndexDescription> localSecondaryIndexes

Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

• IndexName - The name of the local secondary index.

• KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

• Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

  • ProjectionType - One of the following:

    • KEYS_ONLY - Only the index and primary keys are projected into the index.

    • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

    • ALL - All of the table attributes are projected into the index.

  • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

• IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

• ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

If the table is in the DELETING state, no information about indexes will be returned.

provisionedThroughput

ProvisionedThroughputDescription provisionedThroughput

The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

restoreSummary

RestoreSummary restoreSummary

Contains details for the restore.

sSEDescription

SSEDescription sSEDescription

The description of the server-side encryption status on the specified table.

streamSpecification

StreamSpecification streamSpecification

The current DynamoDB Streams configuration for the table.

tableArn

java.lang.String tableArn

The Amazon Resource Name (ARN) that uniquely identifies the table.

tableId

java.lang.String tableId

Unique identifier for the table for which the backup was created.

Constraints:
Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

tableName

java.lang.String tableName

The name of the table.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

tableSizeBytes

java.lang.Long tableSizeBytes

The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

tableStatus

java.lang.String tableStatus

The current state of the table:

• CREATING - The table is being created.

• UPDATING - The table is being updated.

• DELETING - The table is being deleted.

• ACTIVE - The table is ready for use.

Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE

Class com.amazonaws.services.dynamodbv2.model.TableInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.TableNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.Tag extends java.lang.Object implements Serializable

Serialized Fields

key

java.lang.String key

The key of the tag.Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

Constraints:
Length: 1 - 128

value

java.lang.String value

The value of the tag. Tag values are case-sensitive and can be null.

Constraints:
Length: 0 - 256

Class com.amazonaws.services.dynamodbv2.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN).

Constraints:
Length: 1 - 1283

tags

java.util.List<Tag> tags

The tags to be assigned to the Amazon DynamoDB resource.

Class com.amazonaws.services.dynamodbv2.model.TimeToLiveDescription extends java.lang.Object implements Serializable

Serialized Fields

attributeName

java.lang.String attributeName

The name of the Time to Live attribute for items in the table.

Constraints:
Length: 1 - 255

timeToLiveStatus

java.lang.String timeToLiveStatus

The Time to Live status for the table.

Constraints:
Allowed Values: ENABLING, DISABLING, ENABLED, DISABLED

Class com.amazonaws.services.dynamodbv2.model.TimeToLiveSpecification extends java.lang.Object implements Serializable

Serialized Fields

attributeName

java.lang.String attributeName

The name of the Time to Live attribute used to store the expiration time for items in the table.

Constraints:
Length: 1 - 255

enabled

java.lang.Boolean enabled

Indicates whether Time To Live is to be enabled (true) or disabled (false) on the table.

Class com.amazonaws.services.dynamodbv2.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon DyanamoDB resource the tags will be removed from. This value is an Amazon Resource Name (ARN).

Constraints:
Length: 1 - 1283

tagKeys

java.util.List<java.lang.String> tagKeys

A list of tag keys. Existing tags of the resource whose keys are members of this list will be removed from the Amazon DynamoDB resource.

Class com.amazonaws.services.dynamodbv2.model.UpdateContinuousBackupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pointInTimeRecoverySpecification

PointInTimeRecoverySpecification pointInTimeRecoverySpecification

Represents the settings used to enable point in time recovery.

tableName

java.lang.String tableName

The name of the table.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.UpdateContinuousBackupsResult extends java.lang.Object implements Serializable

Serialized Fields

continuousBackupsDescription

ContinuousBackupsDescription continuousBackupsDescription

Represents the continuous backups and point in time recovery settings on the table.

Class com.amazonaws.services.dynamodbv2.model.UpdateGlobalSecondaryIndexAction extends java.lang.Object implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The name of the global secondary index to be updated.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

provisionedThroughput

ProvisionedThroughput provisionedThroughput

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

Class com.amazonaws.services.dynamodbv2.model.UpdateGlobalTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

globalTableName

java.lang.String globalTableName

The global table name.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

replicaUpdates

java.util.List<ReplicaUpdate> replicaUpdates

A list of regions that should be added or removed from the global table.

Class com.amazonaws.services.dynamodbv2.model.UpdateGlobalTableResult extends java.lang.Object implements Serializable

Serialized Fields

globalTableDescription

GlobalTableDescription globalTableDescription

Contains the details of the global table.

Class com.amazonaws.services.dynamodbv2.model.UpdateGlobalTableSettingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

globalTableGlobalSecondaryIndexSettingsUpdate

java.util.List<GlobalTableGlobalSecondaryIndexSettingsUpdate> globalTableGlobalSecondaryIndexSettingsUpdate

Represents the settings of a global secondary index for a global table that will be modified.

globalTableName

java.lang.String globalTableName

The name of the global table

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate

AutoScalingSettingsUpdate globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate

AutoScaling settings for managing provisioned write capacity for the global table.

globalTableProvisionedWriteCapacityUnits

java.lang.Long globalTableProvisionedWriteCapacityUnits

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

Constraints:
Range: 1 -

replicaSettingsUpdate

java.util.List<ReplicaSettingsUpdate> replicaSettingsUpdate

Represents the settings for a global table in a region that will be modified.

Class com.amazonaws.services.dynamodbv2.model.UpdateGlobalTableSettingsResult extends java.lang.Object implements Serializable

Serialized Fields

globalTableName

java.lang.String globalTableName

The name of the global table.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

replicaSettings

java.util.List<ReplicaSettingsDescription> replicaSettings

The region specific settings for the global table.

Class com.amazonaws.services.dynamodbv2.model.UpdateItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeUpdates

java.util.Map<java.lang.String,AttributeValueUpdate> attributeUpdates

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

conditionalOperator

java.lang.String conditionalOperator

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Constraints:
Allowed Values: AND, OR

conditionExpression

java.lang.String conditionExpression

A condition that must be satisfied in order for a conditional update to succeed.

An expression can contain any of the following:

• Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

  These function names are case-sensitive.

• Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

• Logical operators: AND | OR | NOT

For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

expected

java.util.Map<java.lang.String,ExpectedAttributeValue> expected

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

expressionAttributeNames

java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

• To access an attribute whose name conflicts with a DynamoDB reserved word.

• To create a placeholder for repeating occurrences of an attribute name in an expression.

• To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

• Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

• {"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

• #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

expressionAttributeValues

java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

key

java.util.Map<java.lang.String,AttributeValue> key

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

returnConsumedCapacity

java.lang.String returnConsumedCapacity

Determines the level of detail about provisioned throughput consumption that is returned in the response:

• INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

  Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

• TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

• NONE - No ConsumedCapacity details are included in the response.

Constraints:
Allowed Values: INDEXES, TOTAL, NONE

returnItemCollectionMetrics

java.lang.String returnItemCollectionMetrics

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Constraints:
Allowed Values: SIZE, NONE

returnValues

java.lang.String returnValues

Use ReturnValues if you want to get the item attributes as they appear before or after they are updated. For UpdateItem , the valid values are:

• NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

• ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.

• UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.

• ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.

• UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

The values returned are strongly consistent.

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

tableName

java.lang.String tableName

The name of the table containing the item to update.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

updateExpression

java.lang.String updateExpression

An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.

The following action values are available for UpdateExpression.

• SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val

  SET supports the following functions:

  • if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.

  • list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.

  These function names are case-sensitive.

• REMOVE - Removes one or more attributes from an item.

• ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

  • If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

    If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

    Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

  • If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.

    Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.

  The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.

• DELETE - Deletes an element from a set.

  If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.

  The DELETE action only supports set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes.

You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5

For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.

Class com.amazonaws.services.dynamodbv2.model.UpdateItemResult extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,AttributeValue> attributes

A map of attribute values as they appear before or after the UpdateItem operation, as determined by the ReturnValues parameter.

The Attributes map is only present if ReturnValues was specified as something other than NONE in the request. Each element represents one attribute.

consumedCapacity

ConsumedCapacity consumedCapacity

The capacity units consumed by the UpdateItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

itemCollectionMetrics

ItemCollectionMetrics itemCollectionMetrics

Information about item collections, if any, that were affected by the UpdateItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

• ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

• SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

  The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

Class com.amazonaws.services.dynamodbv2.model.UpdateTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeDefinitions

java.util.List<AttributeDefinition> attributeDefinitions

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

globalSecondaryIndexUpdates

java.util.List<GlobalSecondaryIndexUpdate> globalSecondaryIndexUpdates

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

• Create - add a new global secondary index to the table.

• Update - modify the provisioned throughput settings of an existing global secondary index.

• Delete - remove a global secondary index from the table.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

provisionedThroughput

ProvisionedThroughput provisionedThroughput

The new provisioned throughput settings for the specified table or index.

sSESpecification

SSESpecification sSESpecification

The new server-side encryption settings for the specified table.

streamSpecification

StreamSpecification streamSpecification

Represents the DynamoDB Streams configuration for the table.

You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.

tableName

java.lang.String tableName

The name of the table to be updated.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.dynamodbv2.model.UpdateTableResult extends java.lang.Object implements Serializable

Serialized Fields

tableDescription

TableDescription tableDescription

Represents the properties of the table.

Class com.amazonaws.services.dynamodbv2.model.UpdateTimeToLiveRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

java.lang.String tableName

The name of the table to be configured.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

timeToLiveSpecification

TimeToLiveSpecification timeToLiveSpecification

Represents the settings used to enable or disable Time to Live for the specified table.

Class com.amazonaws.services.dynamodbv2.model.UpdateTimeToLiveResult extends java.lang.Object implements Serializable

Serialized Fields

timeToLiveSpecification

TimeToLiveSpecification timeToLiveSpecification

Represents the output of an UpdateTimeToLive operation.

Class com.amazonaws.services.dynamodbv2.model.WriteRequest extends java.lang.Object implements Serializable

Serialized Fields

deleteRequest

DeleteRequest deleteRequest

A request to perform a DeleteItem operation.

putRequest

PutRequest putRequest

A request to perform a PutItem operation.

Package com.amazonaws.services.ec2.model

Class com.amazonaws.services.ec2.model.AcceptVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcPeeringConnectionId

java.lang.String vpcPeeringConnectionId

The ID of the VPC peering connection.

Class com.amazonaws.services.ec2.model.AcceptVpcPeeringConnectionResult extends java.lang.Object implements Serializable

Serialized Fields

vpcPeeringConnection

VpcPeeringConnection vpcPeeringConnection

Information about the VPC peering connection.

Class com.amazonaws.services.ec2.model.AccountAttribute extends java.lang.Object implements Serializable

Serialized Fields

attributeName

java.lang.String attributeName

The name of the account attribute.

attributeValues

com.amazonaws.internal.ListWithAutoConstructFlag<AccountAttributeValue> attributeValues

One or more values for the account attribute.

Class com.amazonaws.services.ec2.model.AccountAttributeValue extends java.lang.Object implements Serializable

Serialized Fields

attributeValue

java.lang.String attributeValue

The value of the attribute.

Class com.amazonaws.services.ec2.model.ActiveInstance extends java.lang.Object implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The ID of the instance.

instanceType

java.lang.String instanceType

The instance type.

spotInstanceRequestId

java.lang.String spotInstanceRequestId

The ID of the Spot instance request.

Class com.amazonaws.services.ec2.model.Address extends java.lang.Object implements Serializable

Serialized Fields

allocationId

java.lang.String allocationId

The ID representing the allocation of the address for use with EC2-VPC.

associationId

java.lang.String associationId

The ID representing the association of the address with an instance in a VPC.

domain

java.lang.String domain

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

Constraints:
Allowed Values: vpc, standard

instanceId

java.lang.String instanceId

The ID of the instance that the address is associated with (if any).

networkInterfaceId

java.lang.String networkInterfaceId

The ID of the network interface.

networkInterfaceOwnerId

java.lang.String networkInterfaceOwnerId

The ID of the AWS account that owns the network interface.

privateIpAddress

java.lang.String privateIpAddress

The private IP address associated with the Elastic IP address.

publicIp

java.lang.String publicIp

The Elastic IP address.

Class com.amazonaws.services.ec2.model.AllocateAddressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

java.lang.String domain

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

Constraints:
Allowed Values: vpc, standard

Class com.amazonaws.services.ec2.model.AllocateAddressResult extends java.lang.Object implements Serializable

Serialized Fields

allocationId

java.lang.String allocationId

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

domain

java.lang.String domain

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

Constraints:
Allowed Values: vpc, standard

publicIp

java.lang.String publicIp

The Elastic IP address.

Class com.amazonaws.services.ec2.model.AllocateHostsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoPlacement

java.lang.String autoPlacement

This is enabled by default. This property allows instances to be automatically placed onto available Dedicated hosts, when you are launching instances without specifying a host ID.

Default: Enabled

Constraints:
Allowed Values: on, off

availabilityZone

java.lang.String availabilityZone

The Availability Zone for the Dedicated hosts.

clientToken

java.lang.String clientToken

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

instanceType

java.lang.String instanceType

Specify the instance type that you want your Dedicated hosts to be configured for. When you specify the instance type, that is the only instance type that you can launch onto that host.

quantity

java.lang.Integer quantity

The number of Dedicated hosts you want to allocate to your account with these parameters.

Class com.amazonaws.services.ec2.model.AllocateHostsResult extends java.lang.Object implements Serializable

Serialized Fields

hostIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> hostIds

The ID of the allocated Dedicated host. This is used when you want to launch an instance onto a specific host.

Class com.amazonaws.services.ec2.model.AssignPrivateIpAddressesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

allowReassignment

java.lang.Boolean allowReassignment

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

networkInterfaceId

java.lang.String networkInterfaceId

The ID of the network interface.

privateIpAddresses

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> privateIpAddresses

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

secondaryPrivateIpAddressCount

java.lang.Integer secondaryPrivateIpAddressCount

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

Class com.amazonaws.services.ec2.model.AssociateAddressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

allocationId

java.lang.String allocationId

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

allowReassociation

java.lang.Boolean allowReassociation

[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

instanceId

java.lang.String instanceId

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

networkInterfaceId

java.lang.String networkInterfaceId

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

privateIpAddress

java.lang.String privateIpAddress

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

publicIp

java.lang.String publicIp

The Elastic IP address. This is required for EC2-Classic.

Class com.amazonaws.services.ec2.model.AssociateAddressResult extends java.lang.Object implements Serializable

Serialized Fields

associationId

java.lang.String associationId

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

Class com.amazonaws.services.ec2.model.AssociateDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dhcpOptionsId

java.lang.String dhcpOptionsId

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.AssociateRouteTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

routeTableId

java.lang.String routeTableId

The ID of the route table.

subnetId

java.lang.String subnetId

The ID of the subnet.

Class com.amazonaws.services.ec2.model.AssociateRouteTableResult extends java.lang.Object implements Serializable

Serialized Fields

associationId

java.lang.String associationId

The route table association ID (needed to disassociate the route table).

Class com.amazonaws.services.ec2.model.AttachClassicLinkVpcRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groups

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> groups

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

instanceId

java.lang.String instanceId

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

vpcId

java.lang.String vpcId

The ID of a ClassicLink-enabled VPC.

Class com.amazonaws.services.ec2.model.AttachClassicLinkVpcResult extends java.lang.Object implements Serializable

Serialized Fields

returnValue

java.lang.Boolean returnValue

Returns true if the request succeeds; otherwise, it returns an error.

Class com.amazonaws.services.ec2.model.AttachInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

internetGatewayId

java.lang.String internetGatewayId

The ID of the Internet gateway.

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.AttachNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deviceIndex

java.lang.Integer deviceIndex

The index of the device for the network interface attachment.

instanceId

java.lang.String instanceId

The ID of the instance.

networkInterfaceId

java.lang.String networkInterfaceId

The ID of the network interface.

Class com.amazonaws.services.ec2.model.AttachNetworkInterfaceResult extends java.lang.Object implements Serializable

Serialized Fields

attachmentId

java.lang.String attachmentId

The ID of the network interface attachment.

Class com.amazonaws.services.ec2.model.AttachVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

device

java.lang.String device

The device name to expose to the instance (for example, /dev/sdh or xvdh).

instanceId

java.lang.String instanceId

The ID of the instance.

volumeId

java.lang.String volumeId

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

Class com.amazonaws.services.ec2.model.AttachVolumeResult extends java.lang.Object implements Serializable

Serialized Fields

attachment

VolumeAttachment attachment

Information about the volume attachment.

Class com.amazonaws.services.ec2.model.AttachVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

java.lang.String vpcId

The ID of the VPC.

vpnGatewayId

java.lang.String vpnGatewayId

The ID of the virtual private gateway.

Class com.amazonaws.services.ec2.model.AttachVpnGatewayResult extends java.lang.Object implements Serializable

Serialized Fields

vpcAttachment

VpcAttachment vpcAttachment

Information about the attachment.

Class com.amazonaws.services.ec2.model.AuthorizeSecurityGroupEgressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cidrIp

java.lang.String cidrIp

The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.

fromPort

java.lang.Integer fromPort

The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

groupId

java.lang.String groupId

The ID of the security group.

ipPermissions

com.amazonaws.internal.ListWithAutoConstructFlag<IpPermission> ipPermissions

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

ipProtocol

java.lang.String ipProtocol

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

sourceSecurityGroupName

java.lang.String sourceSecurityGroupName

The name of a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

sourceSecurityGroupOwnerId

java.lang.String sourceSecurityGroupOwnerId

The AWS account number for a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

toPort

java.lang.Integer toPort

The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

Class com.amazonaws.services.ec2.model.AuthorizeSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cidrIp

java.lang.String cidrIp

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

fromPort

java.lang.Integer fromPort

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

groupId

java.lang.String groupId

The ID of the security group. Required for a nondefault VPC.

groupName

java.lang.String groupName

[EC2-Classic, default VPC] The name of the security group.

ipPermissions

com.amazonaws.internal.ListWithAutoConstructFlag<IpPermission> ipPermissions

A set of IP permissions. Can be used to specify multiple rules in a single command.

ipProtocol

java.lang.String ipProtocol

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all.

sourceSecurityGroupName

java.lang.String sourceSecurityGroupName

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.

sourceSecurityGroupOwnerId

java.lang.String sourceSecurityGroupOwnerId

[EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

toPort

java.lang.Integer toPort

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

Class com.amazonaws.services.ec2.model.AvailabilityZone extends java.lang.Object implements Serializable

Serialized Fields

messages

com.amazonaws.internal.ListWithAutoConstructFlag<AvailabilityZoneMessage> messages

Any messages about the Availability Zone.

regionName

java.lang.String regionName

The name of the region.

state

java.lang.String state

The state of the Availability Zone.

Constraints:
Allowed Values: available, information, impaired, unavailable

zoneName

java.lang.String zoneName

The name of the Availability Zone.

Class com.amazonaws.services.ec2.model.AvailabilityZoneMessage extends java.lang.Object implements Serializable

Serialized Fields

message

java.lang.String message

The message about the Availability Zone.

Class com.amazonaws.services.ec2.model.AvailableCapacity extends java.lang.Object implements Serializable

Serialized Fields

availableInstanceCapacity

com.amazonaws.internal.ListWithAutoConstructFlag<InstanceCapacity> availableInstanceCapacity

The total number of instances that the Dedicated host supports.

availableVCpus

java.lang.Integer availableVCpus

The number of vCPUs available on the Dedicated host.

Class com.amazonaws.services.ec2.model.BlockDeviceMapping extends java.lang.Object implements Serializable

Serialized Fields

deviceName

java.lang.String deviceName

The device name exposed to the instance (for example, /dev/sdh or xvdh).

ebs

EbsBlockDevice ebs

Parameters used to automatically set up EBS volumes when the instance is launched.

noDevice

java.lang.String noDevice

Suppresses the specified device included in the block device mapping of the AMI.

virtualName

java.lang.String virtualName

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

Class com.amazonaws.services.ec2.model.BundleInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

storage

Storage storage

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

Class com.amazonaws.services.ec2.model.BundleInstanceResult extends java.lang.Object implements Serializable

Serialized Fields

bundleTask

BundleTask bundleTask

Information about the bundle task.

Class com.amazonaws.services.ec2.model.BundleTask extends java.lang.Object implements Serializable

Serialized Fields

bundleId

java.lang.String bundleId

The ID of the bundle task.

bundleTaskError

BundleTaskError bundleTaskError

If the task fails, a description of the error.

instanceId

java.lang.String instanceId

The ID of the instance associated with this bundle task.

progress

java.lang.String progress

The level of task completion, as a percent (for example, 20%).

startTime

java.util.Date startTime

The time this task started.

state

java.lang.String state

The state of the task.

Constraints:
Allowed Values: pending, waiting-for-shutdown, bundling, storing, cancelling, complete, failed

storage

Storage storage

The Amazon S3 storage locations.

updateTime

java.util.Date updateTime

The time of the most recent update for the task.

Class com.amazonaws.services.ec2.model.BundleTaskError extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.String code

The error code.

message

java.lang.String message

The error message.

Class com.amazonaws.services.ec2.model.CancelBundleTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bundleId

java.lang.String bundleId

The ID of the bundle task.

Class com.amazonaws.services.ec2.model.CancelBundleTaskResult extends java.lang.Object implements Serializable

Serialized Fields

bundleTask

BundleTask bundleTask

Information about the bundle task.

Class com.amazonaws.services.ec2.model.CancelConversionTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

conversionTaskId

java.lang.String conversionTaskId

The ID of the conversion task.

reasonMessage

java.lang.String reasonMessage

The reason for canceling the conversion task.

Class com.amazonaws.services.ec2.model.CancelExportTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exportTaskId

java.lang.String exportTaskId

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

Class com.amazonaws.services.ec2.model.CancelImportTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cancelReason

java.lang.String cancelReason

The reason for canceling the task.

importTaskId

java.lang.String importTaskId

The ID of the import image or import snapshot task to be canceled.

Class com.amazonaws.services.ec2.model.CancelImportTaskResult extends java.lang.Object implements Serializable

Serialized Fields

importTaskId

java.lang.String importTaskId

The ID of the task being canceled.

previousState

java.lang.String previousState

The current state of the task being canceled.

state

java.lang.String state

The current state of the task being canceled.

Class com.amazonaws.services.ec2.model.CancelledSpotInstanceRequest extends java.lang.Object implements Serializable

Serialized Fields

spotInstanceRequestId

java.lang.String spotInstanceRequestId

The ID of the Spot instance request.

state

java.lang.String state

The state of the Spot instance request.

Constraints:
Allowed Values: active, open, closed, cancelled, completed

Class com.amazonaws.services.ec2.model.CancelReservedInstancesListingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reservedInstancesListingId

java.lang.String reservedInstancesListingId

The ID of the Reserved Instance listing.

Class com.amazonaws.services.ec2.model.CancelReservedInstancesListingResult extends java.lang.Object implements Serializable

Serialized Fields

reservedInstancesListings

com.amazonaws.internal.ListWithAutoConstructFlag<ReservedInstancesListing> reservedInstancesListings

The Reserved Instance listing.

Class com.amazonaws.services.ec2.model.CancelSpotFleetRequestsError extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.String code

The error code.

Constraints:
Allowed Values: fleetRequestIdDoesNotExist, fleetRequestIdMalformed, fleetRequestNotInCancellableState, unexpectedError

message

java.lang.String message

The description for the error code.

Class com.amazonaws.services.ec2.model.CancelSpotFleetRequestsErrorItem extends java.lang.Object implements Serializable

Serialized Fields

error

CancelSpotFleetRequestsError error

The error.

spotFleetRequestId

java.lang.String spotFleetRequestId

The ID of the Spot fleet request.

Class com.amazonaws.services.ec2.model.CancelSpotFleetRequestsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

spotFleetRequestIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> spotFleetRequestIds

The IDs of the Spot fleet requests.

terminateInstances

java.lang.Boolean terminateInstances

Indicates whether to terminate instances for a Spot fleet request if it is canceled successfully.

Class com.amazonaws.services.ec2.model.CancelSpotFleetRequestsResult extends java.lang.Object implements Serializable

Serialized Fields

successfulFleetRequests

com.amazonaws.internal.ListWithAutoConstructFlag<CancelSpotFleetRequestsSuccessItem> successfulFleetRequests

Information about the Spot fleet requests that are successfully canceled.

unsuccessfulFleetRequests

com.amazonaws.internal.ListWithAutoConstructFlag<CancelSpotFleetRequestsErrorItem> unsuccessfulFleetRequests

Information about the Spot fleet requests that are not successfully canceled.

Class com.amazonaws.services.ec2.model.CancelSpotFleetRequestsSuccessItem extends java.lang.Object implements Serializable

Serialized Fields

currentSpotFleetRequestState

java.lang.String currentSpotFleetRequestState

The current state of the Spot fleet request.

Constraints:
Allowed Values: submitted, active, cancelled, failed, cancelled_running, cancelled_terminating, modifying

previousSpotFleetRequestState

java.lang.String previousSpotFleetRequestState

The previous state of the Spot fleet request.

Constraints:
Allowed Values: submitted, active, cancelled, failed, cancelled_running, cancelled_terminating, modifying

spotFleetRequestId

java.lang.String spotFleetRequestId

The ID of the Spot fleet request.

Class com.amazonaws.services.ec2.model.CancelSpotInstanceRequestsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

spotInstanceRequestIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> spotInstanceRequestIds

One or more Spot instance request IDs.

Class com.amazonaws.services.ec2.model.CancelSpotInstanceRequestsResult extends java.lang.Object implements Serializable

Serialized Fields

cancelledSpotInstanceRequests

com.amazonaws.internal.ListWithAutoConstructFlag<CancelledSpotInstanceRequest> cancelledSpotInstanceRequests

One or more Spot instance requests.

Class com.amazonaws.services.ec2.model.ClassicLinkDnsSupport extends java.lang.Object implements Serializable

Serialized Fields

classicLinkDnsSupported

java.lang.Boolean classicLinkDnsSupported

Indicates whether ClassicLink DNS support is enabled for the VPC.

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.ClassicLinkInstance extends java.lang.Object implements Serializable

Serialized Fields

groups

com.amazonaws.internal.ListWithAutoConstructFlag<GroupIdentifier> groups

A list of security groups.

instanceId

java.lang.String instanceId

The ID of the instance.

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the instance.

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.ClientData extends java.lang.Object implements Serializable

Serialized Fields

comment

java.lang.String comment

A user-defined comment about the disk upload.

uploadEnd

java.util.Date uploadEnd

The time that the disk upload ends.

uploadSize

java.lang.Double uploadSize

The size of the uploaded disk image, in GiB.

uploadStart

java.util.Date uploadStart

The time that the disk upload starts.

Class com.amazonaws.services.ec2.model.ConfirmProductInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The ID of the instance.

productCode

java.lang.String productCode

The product code. This must be a product code that you own.

Class com.amazonaws.services.ec2.model.ConfirmProductInstanceResult extends java.lang.Object implements Serializable

Serialized Fields

ownerId

java.lang.String ownerId

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

returnValue

java.lang.Boolean returnValue

The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.

Class com.amazonaws.services.ec2.model.ConversionTask extends java.lang.Object implements Serializable

Serialized Fields

conversionTaskId

java.lang.String conversionTaskId

The ID of the conversion task.

expirationTime

java.lang.String expirationTime

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

importInstance

ImportInstanceTaskDetails importInstance

If the task is for importing an instance, this contains information about the import instance task.

importVolume

ImportVolumeTaskDetails importVolume

If the task is for importing a volume, this contains information about the import volume task.

state

java.lang.String state

The state of the conversion task.

Constraints:
Allowed Values: active, cancelling, cancelled, completed

statusMessage

java.lang.String statusMessage

The status message related to the conversion task.

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the task.

Class com.amazonaws.services.ec2.model.CopyImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

description

java.lang.String description

A description for the new AMI in the destination region.

encrypted

java.lang.Boolean encrypted

Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

kmsKeyId

java.lang.String kmsKeyId

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

name

java.lang.String name

The name of the new AMI in the destination region.

sourceImageId

java.lang.String sourceImageId

The ID of the AMI to copy.

sourceRegion

java.lang.String sourceRegion

The name of the region that contains the AMI to copy.

Class com.amazonaws.services.ec2.model.CopyImageResult extends java.lang.Object implements Serializable

Serialized Fields

imageId

java.lang.String imageId

The ID of the new AMI.

Class com.amazonaws.services.ec2.model.CopySnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

A description for the EBS snapshot.

destinationRegion

java.lang.String destinationRegion

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

encrypted

java.lang.Boolean encrypted

Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

kmsKeyId

java.lang.String kmsKeyId

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

presignedUrl

java.lang.String presignedUrl

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

sourceRegion

java.lang.String sourceRegion

The ID of the region that contains the snapshot to be copied.

sourceSnapshotId

java.lang.String sourceSnapshotId

The ID of the EBS snapshot to copy.

Class com.amazonaws.services.ec2.model.CopySnapshotResult extends java.lang.Object implements Serializable

Serialized Fields

snapshotId

java.lang.String snapshotId

The ID of the new snapshot.

Class com.amazonaws.services.ec2.model.CreateCustomerGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bgpAsn

java.lang.Integer bgpAsn

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

publicIp

java.lang.String publicIp

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

type

java.lang.String type

The type of VPN connection that this customer gateway supports (ipsec.1).

Constraints:
Allowed Values: ipsec.1

Class com.amazonaws.services.ec2.model.CreateCustomerGatewayResult extends java.lang.Object implements Serializable

Serialized Fields

customerGateway

CustomerGateway customerGateway

Information about the customer gateway.

Class com.amazonaws.services.ec2.model.CreateDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dhcpConfigurations

com.amazonaws.internal.ListWithAutoConstructFlag<DhcpConfiguration> dhcpConfigurations

A DHCP configuration option.

Class com.amazonaws.services.ec2.model.CreateDhcpOptionsResult extends java.lang.Object implements Serializable

Serialized Fields

dhcpOptions

DhcpOptions dhcpOptions

A set of DHCP options.

Class com.amazonaws.services.ec2.model.CreateFlowLogsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

deliverLogsPermissionArn

java.lang.String deliverLogsPermissionArn

The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.

logGroupName

java.lang.String logGroupName

The name of the CloudWatch log group.

resourceIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> resourceIds

One or more subnet, network interface, or VPC IDs.

Constraints: Maximum of 1000 resources

resourceType

java.lang.String resourceType

The type of resource on which to create the flow log.

Constraints:
Allowed Values: VPC, Subnet, NetworkInterface

trafficType

java.lang.String trafficType

The type of traffic to log.

Constraints:
Allowed Values: ACCEPT, REJECT, ALL

Class com.amazonaws.services.ec2.model.CreateFlowLogsResult extends java.lang.Object implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

flowLogIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> flowLogIds

The IDs of the flow logs.

unsuccessful

com.amazonaws.internal.ListWithAutoConstructFlag<UnsuccessfulItem> unsuccessful

Information about the flow logs that could not be created successfully.

Class com.amazonaws.services.ec2.model.CreateImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

blockDeviceMappings

com.amazonaws.internal.ListWithAutoConstructFlag<BlockDeviceMapping> blockDeviceMappings

Information about one or more block device mappings.

description

java.lang.String description

A description for the new image.

instanceId

java.lang.String instanceId

The ID of the instance.

name

java.lang.String name

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

noReboot

java.lang.Boolean noReboot

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

Class com.amazonaws.services.ec2.model.CreateImageResult extends java.lang.Object implements Serializable

Serialized Fields

imageId

java.lang.String imageId

The ID of the new AMI.

Class com.amazonaws.services.ec2.model.CreateInstanceExportTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

exportToS3Task

ExportToS3TaskSpecification exportToS3Task

The format and location for an instance export task.

instanceId

java.lang.String instanceId

The ID of the instance.

targetEnvironment

java.lang.String targetEnvironment

The target virtualization environment.

Constraints:
Allowed Values: citrix, vmware, microsoft

Class com.amazonaws.services.ec2.model.CreateInstanceExportTaskResult extends java.lang.Object implements Serializable

Serialized Fields

exportTask

ExportTask exportTask

Information about the instance export task.

Class com.amazonaws.services.ec2.model.CreateInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.ec2.model.CreateInternetGatewayResult extends java.lang.Object implements Serializable

Serialized Fields

internetGateway

InternetGateway internetGateway

Information about the Internet gateway.

Class com.amazonaws.services.ec2.model.CreateKeyPairRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyName

java.lang.String keyName

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

Class com.amazonaws.services.ec2.model.CreateKeyPairResult extends java.lang.Object implements Serializable

Serialized Fields

keyPair

KeyPair keyPair

Information about the key pair.

Class com.amazonaws.services.ec2.model.CreateNatGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

allocationId

java.lang.String allocationId

The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

clientToken

java.lang.String clientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Constraint: Maximum 64 ASCII characters.

subnetId

java.lang.String subnetId

The subnet in which to create the NAT gateway.

Class com.amazonaws.services.ec2.model.CreateNatGatewayResult extends java.lang.Object implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

natGateway

NatGateway natGateway

Information about the NAT gateway.

Class com.amazonaws.services.ec2.model.CreateNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cidrBlock

java.lang.String cidrBlock

The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

egress

java.lang.Boolean egress

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

icmpTypeCode

IcmpTypeCode icmpTypeCode

ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.

networkAclId

java.lang.String networkAclId

The ID of the network ACL.

portRange

PortRange portRange

TCP or UDP protocols: The range of ports the rule applies to.

protocol

java.lang.String protocol

The protocol. A value of -1 means all protocols.

ruleAction

java.lang.String ruleAction

Indicates whether to allow or deny the traffic that matches the rule.

Constraints:
Allowed Values: allow, deny

ruleNumber

java.lang.Integer ruleNumber

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

Class com.amazonaws.services.ec2.model.CreateNetworkAclRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.CreateNetworkAclResult extends java.lang.Object implements Serializable

Serialized Fields

networkAcl

NetworkAcl networkAcl

Information about the network ACL.

Class com.amazonaws.services.ec2.model.CreateNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

A description for the network interface.

groups

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> groups

The IDs of one or more security groups.

privateIpAddress

java.lang.String privateIpAddress

The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

privateIpAddresses

com.amazonaws.internal.ListWithAutoConstructFlag<PrivateIpAddressSpecification> privateIpAddresses

One or more private IP addresses.

secondaryPrivateIpAddressCount

java.lang.Integer secondaryPrivateIpAddressCount

The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

subnetId

java.lang.String subnetId

The ID of the subnet to associate with the network interface.

Class com.amazonaws.services.ec2.model.CreateNetworkInterfaceResult extends java.lang.Object implements Serializable

Serialized Fields

networkInterface

NetworkInterface networkInterface

Information about the network interface.

Class com.amazonaws.services.ec2.model.CreatePlacementGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

java.lang.String groupName

A name for the placement group.

Constraints: Up to 255 ASCII characters

strategy

java.lang.String strategy

The placement strategy.

Constraints:
Allowed Values: cluster

Class com.amazonaws.services.ec2.model.CreateReservedInstancesListingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

instanceCount

java.lang.Integer instanceCount

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

priceSchedules

com.amazonaws.internal.ListWithAutoConstructFlag<PriceScheduleSpecification> priceSchedules

A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.

reservedInstancesId

java.lang.String reservedInstancesId

The ID of the active Reserved Instance.

Class com.amazonaws.services.ec2.model.CreateReservedInstancesListingResult extends java.lang.Object implements Serializable

Serialized Fields

reservedInstancesListings

com.amazonaws.internal.ListWithAutoConstructFlag<ReservedInstancesListing> reservedInstancesListings

Information about the Reserved Instance listing.

Class com.amazonaws.services.ec2.model.CreateRouteRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationCidrBlock

java.lang.String destinationCidrBlock

The CIDR address block used for the destination match. Routing decisions are based on the most specific match.

gatewayId

java.lang.String gatewayId

The ID of an Internet gateway or virtual private gateway attached to your VPC.

instanceId

java.lang.String instanceId

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

natGatewayId

java.lang.String natGatewayId

The ID of a NAT gateway.

networkInterfaceId

java.lang.String networkInterfaceId

The ID of a network interface.

routeTableId

java.lang.String routeTableId

The ID of the route table for the route.

vpcPeeringConnectionId

java.lang.String vpcPeeringConnectionId

The ID of a VPC peering connection.

Class com.amazonaws.services.ec2.model.CreateRouteResult extends java.lang.Object implements Serializable

Serialized Fields

returnValue

java.lang.Boolean returnValue

Returns true if the request succeeds; otherwise, it returns an error.

Class com.amazonaws.services.ec2.model.CreateRouteTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.CreateRouteTableResult extends java.lang.Object implements Serializable

Serialized Fields

routeTable

RouteTable routeTable

Information about the route table.

Class com.amazonaws.services.ec2.model.CreateSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

groupName

java.lang.String groupName

The name of the security group.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

vpcId

java.lang.String vpcId

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

Class com.amazonaws.services.ec2.model.CreateSecurityGroupResult extends java.lang.Object implements Serializable

Serialized Fields

groupId

java.lang.String groupId

The ID of the security group.

Class com.amazonaws.services.ec2.model.CreateSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

A description for the snapshot.

volumeId

java.lang.String volumeId

The ID of the EBS volume.

Class com.amazonaws.services.ec2.model.CreateSnapshotResult extends java.lang.Object implements Serializable

Serialized Fields

snapshot

Snapshot snapshot

Information about the snapshot.

Class com.amazonaws.services.ec2.model.CreateSpotDatafeedSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucket

java.lang.String bucket

The Amazon S3 bucket in which to store the Spot instance data feed.

prefix

java.lang.String prefix

A prefix for the data feed file names.

Class com.amazonaws.services.ec2.model.CreateSpotDatafeedSubscriptionResult extends java.lang.Object implements Serializable

Serialized Fields

spotDatafeedSubscription

SpotDatafeedSubscription spotDatafeedSubscription

The Spot instance data feed subscription.

Class com.amazonaws.services.ec2.model.CreateSubnetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone for the subnet.

Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet.

cidrBlock

java.lang.String cidrBlock

The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.CreateSubnetResult extends java.lang.Object implements Serializable

Serialized Fields

subnet

Subnet subnet

Information about the subnet.

Class com.amazonaws.services.ec2.model.CreateTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resources

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> resources

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

Class com.amazonaws.services.ec2.model.CreateVolumePermission extends java.lang.Object implements Serializable

Serialized Fields

group

java.lang.String group

The specific group that is to be added or removed from a volume's list of create volume permissions.

Constraints:
Allowed Values: all

userId

java.lang.String userId

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

Class com.amazonaws.services.ec2.model.CreateVolumePermissionModifications extends java.lang.Object implements Serializable

Serialized Fields

add

com.amazonaws.internal.ListWithAutoConstructFlag<CreateVolumePermission> add

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

remove

com.amazonaws.internal.ListWithAutoConstructFlag<CreateVolumePermission> remove

Removes a specific AWS account ID or group from a volume's list of create volume permissions.

Class com.amazonaws.services.ec2.model.CreateVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

encrypted

java.lang.Boolean encrypted

Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

iops

java.lang.Integer iops

Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes

kmsKeyId

java.lang.String kmsKeyId

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If a KmsKeyId is specified, the Encrypted flag must also be set.

size

java.lang.Integer size

The size of the volume, in GiBs.

Constraints: 1-16384 for gp2, 4-16384 for io1, 500-16384 for st1, 500-16384 for sc1, and 1-1024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

snapshotId

java.lang.String snapshotId

The snapshot from which to create the volume.

volumeType

java.lang.String volumeType

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: standard

Constraints:
Allowed Values: standard, io1, gp2, sc1, st1

Class com.amazonaws.services.ec2.model.CreateVolumeResult extends java.lang.Object implements Serializable

Serialized Fields

volume

Volume volume

Information about the volume.

Class com.amazonaws.services.ec2.model.CreateVpcEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

policyDocument

java.lang.String policyDocument

A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

routeTableIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> routeTableIds

One or more route table IDs.

serviceName

java.lang.String serviceName

The AWS service name, in the form com.amazonaws.region.service. To get a list of available services, use the DescribeVpcEndpointServices request.

vpcId

java.lang.String vpcId

The ID of the VPC in which the endpoint will be used.

Class com.amazonaws.services.ec2.model.CreateVpcEndpointResult extends java.lang.Object implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

vpcEndpoint

VpcEndpoint vpcEndpoint

Information about the endpoint.

Class com.amazonaws.services.ec2.model.CreateVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

peerOwnerId

java.lang.String peerOwnerId

The AWS account ID of the owner of the peer VPC.

Default: Your AWS account ID

peerVpcId

java.lang.String peerVpcId

The ID of the VPC with which you are creating the VPC peering connection.

vpcId

java.lang.String vpcId

The ID of the requester VPC.

Class com.amazonaws.services.ec2.model.CreateVpcPeeringConnectionResult extends java.lang.Object implements Serializable

Serialized Fields

vpcPeeringConnection

VpcPeeringConnection vpcPeeringConnection

Information about the VPC peering connection.

Class com.amazonaws.services.ec2.model.CreateVpcRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cidrBlock

java.lang.String cidrBlock

The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

instanceTenancy

java.lang.String instanceTenancy

The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default

Constraints:
Allowed Values: default, dedicated, host

Class com.amazonaws.services.ec2.model.CreateVpcResult extends java.lang.Object implements Serializable

Serialized Fields

vpc

Vpc vpc

Information about the VPC.

Class com.amazonaws.services.ec2.model.CreateVpnConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customerGatewayId

java.lang.String customerGatewayId

The ID of the customer gateway.

options

VpnConnectionOptionsSpecification options

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

type

java.lang.String type

The type of VPN connection (ipsec.1).

vpnGatewayId

java.lang.String vpnGatewayId

The ID of the virtual private gateway.

Class com.amazonaws.services.ec2.model.CreateVpnConnectionResult extends java.lang.Object implements Serializable

Serialized Fields

vpnConnection

VpnConnection vpnConnection

Information about the VPN connection.

Class com.amazonaws.services.ec2.model.CreateVpnConnectionRouteRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationCidrBlock

java.lang.String destinationCidrBlock

The CIDR block associated with the local subnet of the customer network.

vpnConnectionId

java.lang.String vpnConnectionId

The ID of the VPN connection.

Class com.amazonaws.services.ec2.model.CreateVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone for the virtual private gateway.

type

java.lang.String type

The type of VPN connection this virtual private gateway supports.

Constraints:
Allowed Values: ipsec.1

Class com.amazonaws.services.ec2.model.CreateVpnGatewayResult extends java.lang.Object implements Serializable

Serialized Fields

vpnGateway

VpnGateway vpnGateway

Information about the virtual private gateway.

Class com.amazonaws.services.ec2.model.CustomerGateway extends java.lang.Object implements Serializable

Serialized Fields

bgpAsn

java.lang.String bgpAsn

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

customerGatewayId

java.lang.String customerGatewayId

The ID of the customer gateway.

ipAddress

java.lang.String ipAddress

The Internet-routable IP address of the customer gateway's outside interface.

state

java.lang.String state

The current state of the customer gateway (pending | available | deleting | deleted).

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the customer gateway.

type

java.lang.String type

The type of VPN connection the customer gateway supports (ipsec.1).

Class com.amazonaws.services.ec2.model.DeleteCustomerGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customerGatewayId

java.lang.String customerGatewayId

The ID of the customer gateway.

Class com.amazonaws.services.ec2.model.DeleteDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dhcpOptionsId

java.lang.String dhcpOptionsId

The ID of the DHCP options set.

Class com.amazonaws.services.ec2.model.DeleteFlowLogsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

flowLogIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> flowLogIds

One or more flow log IDs.

Class com.amazonaws.services.ec2.model.DeleteFlowLogsResult extends java.lang.Object implements Serializable

Serialized Fields

unsuccessful

com.amazonaws.internal.ListWithAutoConstructFlag<UnsuccessfulItem> unsuccessful

Information about the flow logs that could not be deleted successfully.

Class com.amazonaws.services.ec2.model.DeleteInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

internetGatewayId

java.lang.String internetGatewayId

The ID of the Internet gateway.

Class com.amazonaws.services.ec2.model.DeleteKeyPairRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyName

java.lang.String keyName

The name of the key pair.

Class com.amazonaws.services.ec2.model.DeleteNatGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

natGatewayId

java.lang.String natGatewayId

The ID of the NAT gateway.

Class com.amazonaws.services.ec2.model.DeleteNatGatewayResult extends java.lang.Object implements Serializable

Serialized Fields

natGatewayId

java.lang.String natGatewayId

The ID of the NAT gateway.

Class com.amazonaws.services.ec2.model.DeleteNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

egress

java.lang.Boolean egress

Indicates whether the rule is an egress rule.

networkAclId

java.lang.String networkAclId

The ID of the network ACL.

ruleNumber

java.lang.Integer ruleNumber

The rule number of the entry to delete.

Class com.amazonaws.services.ec2.model.DeleteNetworkAclRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkAclId

java.lang.String networkAclId

The ID of the network ACL.

Class com.amazonaws.services.ec2.model.DeleteNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkInterfaceId

java.lang.String networkInterfaceId

The ID of the network interface.

Class com.amazonaws.services.ec2.model.DeletePlacementGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

java.lang.String groupName

The name of the placement group.

Class com.amazonaws.services.ec2.model.DeleteRouteRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationCidrBlock

java.lang.String destinationCidrBlock

The CIDR range for the route. The value you specify must match the CIDR for the route exactly.

routeTableId

java.lang.String routeTableId

The ID of the route table.

Class com.amazonaws.services.ec2.model.DeleteRouteTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

routeTableId

java.lang.String routeTableId

The ID of the route table.

Class com.amazonaws.services.ec2.model.DeleteSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupId

java.lang.String groupId

The ID of the security group. Required for a nondefault VPC.

groupName

java.lang.String groupName

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

Class com.amazonaws.services.ec2.model.DeleteSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

snapshotId

java.lang.String snapshotId

The ID of the EBS snapshot.

Class com.amazonaws.services.ec2.model.DeleteSpotDatafeedSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.ec2.model.DeleteSubnetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subnetId

java.lang.String subnetId

The ID of the subnet.

Class com.amazonaws.services.ec2.model.DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resources

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> resources

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.

Class com.amazonaws.services.ec2.model.DeleteVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeId

java.lang.String volumeId

The ID of the volume.

Class com.amazonaws.services.ec2.model.DeleteVpcEndpointsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcEndpointIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> vpcEndpointIds

One or more endpoint IDs.

Class com.amazonaws.services.ec2.model.DeleteVpcEndpointsResult extends java.lang.Object implements Serializable

Serialized Fields

unsuccessful

com.amazonaws.internal.ListWithAutoConstructFlag<UnsuccessfulItem> unsuccessful

Information about the endpoints that were not successfully deleted.

Class com.amazonaws.services.ec2.model.DeleteVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcPeeringConnectionId

java.lang.String vpcPeeringConnectionId

The ID of the VPC peering connection.

Class com.amazonaws.services.ec2.model.DeleteVpcPeeringConnectionResult extends java.lang.Object implements Serializable

Serialized Fields

returnValue

java.lang.Boolean returnValue

Returns true if the request succeeds; otherwise, it returns an error.

Class com.amazonaws.services.ec2.model.DeleteVpcRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.DeleteVpnConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpnConnectionId

java.lang.String vpnConnectionId

The ID of the VPN connection.

Class com.amazonaws.services.ec2.model.DeleteVpnConnectionRouteRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationCidrBlock

java.lang.String destinationCidrBlock

The CIDR block associated with the local subnet of the customer network.

vpnConnectionId

java.lang.String vpnConnectionId

The ID of the VPN connection.

Class com.amazonaws.services.ec2.model.DeleteVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpnGatewayId

java.lang.String vpnGatewayId

The ID of the virtual private gateway.

Class com.amazonaws.services.ec2.model.DeregisterImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

imageId

java.lang.String imageId

The ID of the AMI.

Class com.amazonaws.services.ec2.model.DescribeAccountAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeNames

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> attributeNames

One or more account attribute names.

Class com.amazonaws.services.ec2.model.DescribeAccountAttributesResult extends java.lang.Object implements Serializable

Serialized Fields

accountAttributes

com.amazonaws.internal.ListWithAutoConstructFlag<AccountAttribute> accountAttributes

Information about one or more account attributes.

Class com.amazonaws.services.ec2.model.DescribeAddressesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

allocationIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> allocationIds

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters. Filter names and values are case-sensitive.

• allocation-id - [EC2-VPC] The allocation ID for the address.

• association-id - [EC2-VPC] The association ID for the address.

• domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

• instance-id - The ID of the instance the address is associated with, if any.

• network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

• network-interface-owner-id - The AWS account ID of the owner.

• private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

• public-ip - The Elastic IP address.

publicIps

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> publicIps

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

Class com.amazonaws.services.ec2.model.DescribeAddressesResult extends java.lang.Object implements Serializable

Serialized Fields

addresses

com.amazonaws.internal.ListWithAutoConstructFlag<Address> addresses

Information about one or more Elastic IP addresses.

Class com.amazonaws.services.ec2.model.DescribeAvailabilityZonesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• message - Information about the Availability Zone.

• region-name - The name of the region for the Availability Zone (for example, us-east-1).

• state - The state of the Availability Zone (available | information | impaired | unavailable).

• zone-name - The name of the Availability Zone (for example, us-east-1a).

zoneNames

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> zoneNames

The names of one or more Availability Zones.

Class com.amazonaws.services.ec2.model.DescribeAvailabilityZonesResult extends java.lang.Object implements Serializable

Serialized Fields

availabilityZones

com.amazonaws.internal.ListWithAutoConstructFlag<AvailabilityZone> availabilityZones

Information about one or more Availability Zones.

Class com.amazonaws.services.ec2.model.DescribeBundleTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bundleIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> bundleIds

One or more bundle task IDs.

Default: Describes all your bundle tasks.

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• bundle-id - The ID of the bundle task.

• error-code - If the task failed, the error code returned.

• error-message - If the task failed, the error message returned.

• instance-id - The ID of the instance.

• progress - The level of task completion, as a percentage (for example, 20%).

• s3-bucket - The Amazon S3 bucket to store the AMI.

• s3-prefix - The beginning of the AMI name.

• start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

• state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

• update-time - The time of the most recent update for the task.

Class com.amazonaws.services.ec2.model.DescribeBundleTasksResult extends java.lang.Object implements Serializable

Serialized Fields

bundleTasks

com.amazonaws.internal.ListWithAutoConstructFlag<BundleTask> bundleTasks

Information about one or more bundle tasks.

Class com.amazonaws.services.ec2.model.DescribeClassicLinkInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• group-id - The ID of a VPC security group that's associated with the instance.

• instance-id - The ID of the instance.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• vpc-id - The ID of the VPC that the instance is linked to.

instanceIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> instanceIds

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

maxResults

java.lang.Integer maxResults

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

nextToken

java.lang.String nextToken

The token to retrieve the next page of results.

Class com.amazonaws.services.ec2.model.DescribeClassicLinkInstancesResult extends java.lang.Object implements Serializable

Serialized Fields

instances

com.amazonaws.internal.ListWithAutoConstructFlag<ClassicLinkInstance> instances

Information about one or more linked EC2-Classic instances.

nextToken

java.lang.String nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Class com.amazonaws.services.ec2.model.DescribeConversionTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

conversionTaskIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> conversionTaskIds

One or more conversion task IDs.

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

Class com.amazonaws.services.ec2.model.DescribeConversionTasksResult extends java.lang.Object implements Serializable

Serialized Fields

conversionTasks

com.amazonaws.internal.ListWithAutoConstructFlag<ConversionTask> conversionTasks

Information about the conversion tasks.

Class com.amazonaws.services.ec2.model.DescribeCustomerGatewaysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customerGatewayIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> customerGatewayIds

One or more customer gateway IDs.

Default: Describes all your customer gateways.

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

• customer-gateway-id - The ID of the customer gateway.

• ip-address - The IP address of the customer gateway's Internet-routable external interface.

• state - The state of the customer gateway (pending | available | deleting | deleted).

• type - The type of customer gateway. Currently, the only supported type is ipsec.1.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Class com.amazonaws.services.ec2.model.DescribeCustomerGatewaysResult extends java.lang.Object implements Serializable

Serialized Fields

customerGateways

com.amazonaws.internal.ListWithAutoConstructFlag<CustomerGateway> customerGateways

Information about one or more customer gateways.

Class com.amazonaws.services.ec2.model.DescribeDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dhcpOptionsIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> dhcpOptionsIds

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• dhcp-options-id - The ID of a set of DHCP options.

• key - The key for one of the options (for example, domain-name).

• value - The value for one of the options.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Class com.amazonaws.services.ec2.model.DescribeDhcpOptionsResult extends java.lang.Object implements Serializable

Serialized Fields

dhcpOptions

com.amazonaws.internal.ListWithAutoConstructFlag<DhcpOptions> dhcpOptions

Information about one or more DHCP options sets.

Class com.amazonaws.services.ec2.model.DescribeExportTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exportTaskIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> exportTaskIds

One or more export task IDs.

Class com.amazonaws.services.ec2.model.DescribeExportTasksResult extends java.lang.Object implements Serializable

Serialized Fields

exportTasks

com.amazonaws.internal.ListWithAutoConstructFlag<ExportTask> exportTasks

Information about the export tasks.

Class com.amazonaws.services.ec2.model.DescribeFlowLogsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filter

One or more filters.

• deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

• flow-log-id - The ID of the flow log.

• log-group-name - The name of the log group.

• resource-id - The ID of the VPC, subnet, or network interface.

• traffic-type - The type of traffic (ACCEPT | REJECT | ALL)

flowLogIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> flowLogIds

One or more flow log IDs.

maxResults

java.lang.Integer maxResults

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the flow log IDs parameter in the same request.

nextToken

java.lang.String nextToken

The token to retrieve the next page of results.

Class com.amazonaws.services.ec2.model.DescribeFlowLogsResult extends java.lang.Object implements Serializable

Serialized Fields

flowLogs

com.amazonaws.internal.ListWithAutoConstructFlag<FlowLog> flowLogs

Information about the flow logs.

nextToken

java.lang.String nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Class com.amazonaws.services.ec2.model.DescribeHostsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filter

One or more filters.

• instance-type - The instance type size that the Dedicated host is configured to support.

• auto-placement - Whether auto-placement is enabled or disabled (on | off).

• host-reservation-id - The ID of the reservation associated with this host.

• client-token - The idempotency token you provided when you launched the instance

• state- The allocation state of the Dedicated host (available | under-assessment | permanent-failure | released | released-permanent-failure).

• availability-zone - The Availability Zone of the host.

hostIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> hostIds

The IDs of the Dedicated hosts. The IDs are used for targeted instance launches.

maxResults

java.lang.Integer maxResults

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error. You cannot specify this parameter and the host IDs parameter in the same request.

nextToken

java.lang.String nextToken

The token to retrieve the next page of results.

Class com.amazonaws.services.ec2.model.DescribeHostsResult extends java.lang.Object implements Serializable

Serialized Fields

hosts

com.amazonaws.internal.ListWithAutoConstructFlag<Host> hosts

Information about the Dedicated hosts.

nextToken

java.lang.String nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Class com.amazonaws.services.ec2.model.DescribeIdFormatRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resource

java.lang.String resource

The type of resource.

Class com.amazonaws.services.ec2.model.DescribeIdFormatResult extends java.lang.Object implements Serializable

Serialized Fields

statuses

com.amazonaws.internal.ListWithAutoConstructFlag<IdFormat> statuses

Information about the ID format for the resource.

Class com.amazonaws.services.ec2.model.DescribeImageAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

java.lang.String attribute

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

Constraints:
Allowed Values: description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping, sriovNetSupport

imageId

java.lang.String imageId

The ID of the AMI.

Class com.amazonaws.services.ec2.model.DescribeImageAttributeResult extends java.lang.Object implements Serializable

Serialized Fields

imageAttribute

ImageAttribute imageAttribute

Information about the image attribute.

Class com.amazonaws.services.ec2.model.DescribeImagesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

executableUsers

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> executableUsers

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• architecture - The image architecture (i386 | x86_64).

• block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

• block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

• block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

• block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

• block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

• description - The description of the image (provided during image creation).

• hypervisor - The hypervisor type (ovm | xen).

• image-id - The ID of the image.

• image-type - The image type (machine | kernel | ramdisk).

• is-public - A Boolean that indicates whether the image is public.

• kernel-id - The kernel ID.

• manifest-location - The location of the image manifest.

• name - The name of the AMI (provided during image creation).

• owner-alias - The AWS account alias (for example, amazon).

• owner-id - The AWS account ID of the image owner.

• platform - The platform. To only list Windows-based AMIs, use windows.

• product-code - The product code.

• product-code.type - The type of the product code (devpay | marketplace).

• ramdisk-id - The RAM disk ID.

• root-device-name - The name of the root device volume (for example, /dev/sda1).

• root-device-type - The type of the root device volume (ebs | instance-store).

• state - The state of the image (available | pending | failed).

• state-reason-code - The reason code for the state change.

• state-reason-message - The message for the state change.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• virtualization-type - The virtualization type (paravirtual | hvm).

imageIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> imageIds

One or more image IDs.

Default: Describes all images available to you.

owners

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> owners

Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

Class com.amazonaws.services.ec2.model.DescribeImagesResult extends java.lang.Object implements Serializable

Serialized Fields

images

com.amazonaws.internal.ListWithAutoConstructFlag<Image> images

Information about one or more images.

Class com.amazonaws.services.ec2.model.DescribeImportImageTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

Filter tasks using the task-state filter and one of the following values: active, completed, deleting, deleted.

importTaskIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> importTaskIds

A list of import image task IDs.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken

java.lang.String nextToken

A token that indicates the next page of results.

Class com.amazonaws.services.ec2.model.DescribeImportImageTasksResult extends java.lang.Object implements Serializable

Serialized Fields

importImageTasks

com.amazonaws.internal.ListWithAutoConstructFlag<ImportImageTask> importImageTasks

A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.

nextToken

java.lang.String nextToken

The token to use to get the next page of results. This value is null when there are no more results to return.

Class com.amazonaws.services.ec2.model.DescribeImportSnapshotTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

importTaskIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> importTaskIds

A list of import snapshot task IDs.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken

java.lang.String nextToken

A token that indicates the next page of results.

Class com.amazonaws.services.ec2.model.DescribeImportSnapshotTasksResult extends java.lang.Object implements Serializable

Serialized Fields

importSnapshotTasks

com.amazonaws.internal.ListWithAutoConstructFlag<ImportSnapshotTask> importSnapshotTasks

A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.

nextToken

java.lang.String nextToken

The token to use to get the next page of results. This value is null when there are no more results to return.

Class com.amazonaws.services.ec2.model.DescribeInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

java.lang.String attribute

The instance attribute.

Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport

instanceId

java.lang.String instanceId

The ID of the instance.

Class com.amazonaws.services.ec2.model.DescribeInstanceAttributeResult extends java.lang.Object implements Serializable

Serialized Fields

instanceAttribute

InstanceAttribute instanceAttribute

Information about the instance attribute.

Class com.amazonaws.services.ec2.model.DescribeInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• affinity - The affinity setting for an instance running on a Dedicated host (default | host).

• architecture - The instance architecture (i386 | x86_64).

• availability-zone - The Availability Zone of the instance.

• block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.

• block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.

• block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh or xvdh).

• block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).

• block-device-mapping.volume-id - The volume ID of the EBS volume.

• client-token - The idempotency token you provided when you launched the instance.

• dns-name - The public DNS name of the instance.

• group-id - The ID of the security group for the instance. EC2-Classic only.

• group-name - The name of the security group for the instance. EC2-Classic only.

• host-Id - The ID of the Dedicated host on which the instance is running, if applicable.

• hypervisor - The hypervisor type of the instance (ovm | xen).

• iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

• image-id - The ID of the image used to launch the instance.

• instance-id - The ID of the instance.

• instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).

• instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

• instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

• instance-type - The type of instance (for example, t2.micro).

• instance.group-id - The ID of the security group for the instance.

• instance.group-name - The name of the security group for the instance.

• ip-address - The public IP address of the instance.

• kernel-id - The kernel ID.

• key-name - The name of the key pair used when the instance was launched.

• launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).

• launch-time - The time when the instance was launched.

• monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).

• owner-id - The AWS account ID of the instance owner.

• placement-group-name - The name of the placement group for the instance.

• platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.

• private-dns-name - The private DNS name of the instance.

• private-ip-address - The private IP address of the instance.

• product-code - The product code associated with the AMI used to launch the instance.

• product-code.type - The type of product code (devpay | marketplace).

• ramdisk-id - The RAM disk ID.

• reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.

• requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

• reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you'll get one reservation ID. If you launch ten instances using the same launch request, you'll also get one reservation ID.

• root-device-name - The name of the root device for the instance (for example, /dev/sda1 or /dev/xvda).

• root-device-type - The type of root device that the instance uses (ebs | instance-store).

• source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.

• spot-instance-request-id - The ID of the Spot instance request.

• state-reason-code - The reason code for the state change.

• state-reason-message - A message that describes the state change.

• subnet-id - The ID of the subnet for the instance.

• tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• tenancy - The tenancy of an instance (dedicated | default | host).

• virtualization-type - The virtualization type of the instance (paravirtual | hvm).

• vpc-id - The ID of the VPC that the instance is running in.

• network-interface.description - The description of the network interface.

• network-interface.subnet-id - The ID of the subnet for the network interface.

• network-interface.vpc-id - The ID of the VPC for the network interface.

• network-interface.network-interface-id - The ID of the network interface.

• network-interface.owner-id - The ID of the owner of the network interface.

• network-interface.availability-zone - The Availability Zone for the network interface.

• network-interface.requester-id - The requester ID for the network interface.

• network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

• network-interface.status - The status of the network interface (available) | in-use).

• network-interface.mac-address - The MAC address of the network interface.

• network-interface.private-dns-name - The private DNS name of the network interface.

• network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

• network-interface.group-id - The ID of a security group associated with the network interface.

• network-interface.group-name - The name of a security group associated with the network interface.

• network-interface.attachment.attachment-id - The ID of the interface attachment.

• network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

• network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

• network-interface.addresses.private-ip-address - The private IP address associated with the network interface.

• network-interface.attachment.device-index - The device index to which the network interface is attached.

• network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

• network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

• network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

• network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.

• network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.

• network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.

• association.public-ip - The address of the Elastic IP address bound to the network interface.

• association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

• association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

• association.association-id - The association ID returned when the network interface was associated with an IP address.

instanceIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> instanceIds

One or more instance IDs.

Default: Describes all your instances.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter or tag filters in the same call.

nextToken

java.lang.String nextToken

The token to request the next page of results.

Class com.amazonaws.services.ec2.model.DescribeInstancesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

reservations

com.amazonaws.internal.ListWithAutoConstructFlag<Reservation> reservations

Zero or more reservations.

Class com.amazonaws.services.ec2.model.DescribeInstanceStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• availability-zone - The Availability Zone of the instance.

• event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

• event.description - A description of the event.

• event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

• event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

• instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

• instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

• instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

• instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

• system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

• system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

includeAllInstances

java.lang.Boolean includeAllInstances

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

instanceIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> instanceIds

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

nextToken

java.lang.String nextToken

The token to retrieve the next page of results.

Class com.amazonaws.services.ec2.model.DescribeInstanceStatusResult extends java.lang.Object implements Serializable

Serialized Fields

instanceStatuses

com.amazonaws.internal.ListWithAutoConstructFlag<InstanceStatus> instanceStatuses

One or more instance status descriptions.

nextToken

java.lang.String nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Class com.amazonaws.services.ec2.model.DescribeInternetGatewaysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

• attachment.vpc-id - The ID of an attached VPC.

• internet-gateway-id - The ID of the Internet gateway.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

internetGatewayIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> internetGatewayIds

One or more Internet gateway IDs.

Default: Describes all your Internet gateways.

Class com.amazonaws.services.ec2.model.DescribeInternetGatewaysResult extends java.lang.Object implements Serializable

Serialized Fields

internetGateways

com.amazonaws.internal.ListWithAutoConstructFlag<InternetGateway> internetGateways

Information about one or more Internet gateways.

Class com.amazonaws.services.ec2.model.DescribeKeyPairsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• fingerprint - The fingerprint of the key pair.

• key-name - The name of the key pair.

keyNames

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> keyNames

One or more key pair names.

Default: Describes all your key pairs.

Class com.amazonaws.services.ec2.model.DescribeKeyPairsResult extends java.lang.Object implements Serializable

Serialized Fields

keyPairs

com.amazonaws.internal.ListWithAutoConstructFlag<KeyPairInfo> keyPairs

Information about one or more key pairs.

Class com.amazonaws.services.ec2.model.DescribeMovingAddressesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).

maxResults

java.lang.Integer maxResults

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.

Default: If no value is provided, the default is 1000.

nextToken

java.lang.String nextToken

The token to use to retrieve the next page of results.

publicIps

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> publicIps

One or more Elastic IP addresses.

Class com.amazonaws.services.ec2.model.DescribeMovingAddressesResult extends java.lang.Object implements Serializable

Serialized Fields

movingAddressStatuses

com.amazonaws.internal.ListWithAutoConstructFlag<MovingAddressStatus> movingAddressStatuses

The status for each Elastic IP address.

nextToken

java.lang.String nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Class com.amazonaws.services.ec2.model.DescribeNatGatewaysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filter

One or more filters.

• nat-gateway-id - The ID of the NAT gateway.

• state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

• subnet-id - The ID of the subnet in which the NAT gateway resides.

• vpc-id - The ID of the VPC in which the NAT gateway resides.

maxResults

java.lang.Integer maxResults

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

natGatewayIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> natGatewayIds

One or more NAT gateway IDs.

nextToken

java.lang.String nextToken

The token to retrieve the next page of results.

Class com.amazonaws.services.ec2.model.DescribeNatGatewaysResult extends java.lang.Object implements Serializable

Serialized Fields

natGateways

com.amazonaws.internal.ListWithAutoConstructFlag<NatGateway> natGateways

Information about the NAT gateways.

nextToken

java.lang.String nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Class com.amazonaws.services.ec2.model.DescribeNetworkAclsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• association.association-id - The ID of an association ID for the ACL.

• association.network-acl-id - The ID of the network ACL involved in the association.

• association.subnet-id - The ID of the subnet involved in the association.

• default - Indicates whether the ACL is the default network ACL for the VPC.

• entry.cidr - The CIDR range specified in the entry.

• entry.egress - Indicates whether the entry applies to egress traffic.

• entry.icmp.code - The ICMP code specified in the entry, if any.

• entry.icmp.type - The ICMP type specified in the entry, if any.

• entry.port-range.from - The start of the port range specified in the entry.

• entry.port-range.to - The end of the port range specified in the entry.

• entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

• entry.rule-action - Allows or denies the matching traffic (allow | deny).

• entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.

• network-acl-id - The ID of the network ACL.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• vpc-id - The ID of the VPC for the network ACL.

networkAclIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> networkAclIds

One or more network ACL IDs.

Default: Describes all your network ACLs.

Class com.amazonaws.services.ec2.model.DescribeNetworkAclsResult extends java.lang.Object implements Serializable

Serialized Fields

networkAcls

com.amazonaws.internal.ListWithAutoConstructFlag<NetworkAcl> networkAcls

Information about one or more network ACLs.

Class com.amazonaws.services.ec2.model.DescribeNetworkInterfaceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

java.lang.String attribute

The attribute of the network interface.

Constraints:
Allowed Values: description, groupSet, sourceDestCheck, attachment

networkInterfaceId

java.lang.String networkInterfaceId

The ID of the network interface.

Class com.amazonaws.services.ec2.model.DescribeNetworkInterfaceAttributeResult extends java.lang.Object implements Serializable

Serialized Fields

attachment

NetworkInterfaceAttachment attachment

The attachment (if any) of the network interface.

description

java.lang.String description

The description of the network interface.

groups

com.amazonaws.internal.ListWithAutoConstructFlag<GroupIdentifier> groups

The security groups associated with the network interface.

networkInterfaceId

java.lang.String networkInterfaceId

The ID of the network interface.

sourceDestCheck

java.lang.Boolean sourceDestCheck

Indicates whether source/destination checking is enabled.

Class com.amazonaws.services.ec2.model.DescribeNetworkInterfacesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• addresses.private-ip-address - The private IP addresses associated with the network interface.

• addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.

• addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.

• addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

• association.association-id - The association ID returned when the network interface was associated with an IP address.

• association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

• association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

• association.public-ip - The address of the Elastic IP address bound to the network interface.

• association.public-dns-name - The public DNS name for the network interface.

• attachment.attachment-id - The ID of the interface attachment.

• attachment.attach.time - The time that the network interface was attached to an instance.

• attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

• attachment.device-index - The device index to which the network interface is attached.

• attachment.instance-id - The ID of the instance to which the network interface is attached.

• attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

• attachment.nat-gateway-id - The ID of the NAT gateway to which the network interface is attached.

• attachment.status - The status of the attachment (attaching | attached | detaching | detached).

• availability-zone - The Availability Zone of the network interface.

• description - The description of the network interface.

• group-id - The ID of a security group associated with the network interface.

• group-name - The name of a security group associated with the network interface.

• mac-address - The MAC address of the network interface.

• network-interface-id - The ID of the network interface.

• owner-id - The AWS account ID of the network interface owner.

• private-ip-address - The private IP address or addresses of the network interface.

• private-dns-name - The private DNS name of the network interface.

• requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

• requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

• source-desk-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

• status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

• subnet-id - The ID of the subnet for the network interface.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• vpc-id - The ID of the VPC for the network interface.

networkInterfaceIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> networkInterfaceIds

One or more network interface IDs.

Default: Describes all your network interfaces.

Class com.amazonaws.services.ec2.model.DescribeNetworkInterfacesResult extends java.lang.Object implements Serializable

Serialized Fields

networkInterfaces

com.amazonaws.internal.ListWithAutoConstructFlag<NetworkInterface> networkInterfaces

Information about one or more network interfaces.

Class com.amazonaws.services.ec2.model.DescribePlacementGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• group-name - The name of the placement group.

• state - The state of the placement group (pending | available | deleting | deleted).

• strategy - The strategy of the placement group (cluster).

groupNames

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> groupNames

One or more placement group names.

Default: Describes all your placement groups, or only those otherwise specified.

Class com.amazonaws.services.ec2.model.DescribePlacementGroupsResult extends java.lang.Object implements Serializable

Serialized Fields

placementGroups

com.amazonaws.internal.ListWithAutoConstructFlag<PlacementGroup> placementGroups

One or more placement groups.

Class com.amazonaws.services.ec2.model.DescribePrefixListsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• prefix-list-id: The ID of a prefix list.

• prefix-list-name: The name of a prefix list.

maxResults

java.lang.Integer maxResults

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

nextToken

java.lang.String nextToken

The token for the next set of items to return. (You received this token from a prior call.)

prefixListIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> prefixListIds

One or more prefix list IDs.

Class com.amazonaws.services.ec2.model.DescribePrefixListsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

prefixLists

com.amazonaws.internal.ListWithAutoConstructFlag<PrefixList> prefixLists

All available prefix lists.

Class com.amazonaws.services.ec2.model.DescribeRegionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

• region-name - The name of the region (for example, us-east-1).

regionNames

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> regionNames

The names of one or more regions.

Class com.amazonaws.services.ec2.model.DescribeRegionsResult extends java.lang.Object implements Serializable

Serialized Fields

regions

com.amazonaws.internal.ListWithAutoConstructFlag<Region> regions

Information about one or more regions.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesListingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• reserved-instances-id - The ID of the Reserved Instances.

• reserved-instances-listing-id - The ID of the Reserved Instances listing.

• status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

• status-message - The reason for the status.

reservedInstancesId

java.lang.String reservedInstancesId

One or more Reserved Instance IDs.

reservedInstancesListingId

java.lang.String reservedInstancesListingId

One or more Reserved Instance listing IDs.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesListingsResult extends java.lang.Object implements Serializable

Serialized Fields

reservedInstancesListings

com.amazonaws.internal.ListWithAutoConstructFlag<ReservedInstancesListing> reservedInstancesListings

Information about the Reserved Instance listing.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesModificationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• client-token - The idempotency token for the modification request.

• create-date - The time when the modification request was created.

• effective-date - The time when the modification becomes effective.

• modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

• modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

• modification-result.target-configuration.instance-count - The number of new Reserved Instances.

• modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

• modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

• reserved-instances-id - The ID of the Reserved Instances modified.

• reserved-instances-modification-id - The ID of the modification request.

• status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

• status-message - The reason for the status.

• update-date - The time when the modification request was last updated.

nextToken

java.lang.String nextToken

The token to retrieve the next page of results.

reservedInstancesModificationIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> reservedInstancesModificationIds

IDs for the submitted modification request.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesModificationsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

reservedInstancesModifications

com.amazonaws.internal.ListWithAutoConstructFlag<ReservedInstancesModification> reservedInstancesModifications

The Reserved Instance modification information.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesOfferingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone in which the Reserved Instance can be used.

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• availability-zone - The Availability Zone where the Reserved Instance can be used.

• duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

• fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

• instance-type - The instance type that is covered by the reservation.

• marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance Marketplace are listed.

• product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))

• reserved-instances-offering-id - The Reserved Instances offering ID.

• usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

includeMarketplace

java.lang.Boolean includeMarketplace

Include Reserved Instance Marketplace offerings in the response.

instanceTenancy

java.lang.String instanceTenancy

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

Default: default

Constraints:
Allowed Values: default, dedicated, host

instanceType

java.lang.String instanceType

The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge

maxDuration

java.lang.Long maxDuration

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

maxInstanceCount

java.lang.Integer maxInstanceCount

The maximum number of instances to filter when searching for offerings.

Default: 20

maxResults

java.lang.Integer maxResults

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

minDuration

java.lang.Long minDuration

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

nextToken

java.lang.String nextToken

The token to retrieve the next page of results.

offeringType

java.lang.String offeringType

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront

productDescription

java.lang.String productDescription

The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)

reservedInstancesOfferingIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> reservedInstancesOfferingIds

One or more Reserved Instances offering IDs.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesOfferingsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

reservedInstancesOfferings

com.amazonaws.internal.ListWithAutoConstructFlag<ReservedInstancesOffering> reservedInstancesOfferings

A list of Reserved Instances offerings.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• availability-zone - The Availability Zone where the Reserved Instance can be used.

• duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

• end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

• fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

• instance-type - The instance type that is covered by the reservation.

• product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).

• reserved-instances-id - The ID of the Reserved Instance.

• start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

• state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

offeringType

java.lang.String offeringType

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront

reservedInstancesIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> reservedInstancesIds

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesResult extends java.lang.Object implements Serializable

Serialized Fields

reservedInstances

com.amazonaws.internal.ListWithAutoConstructFlag<ReservedInstances> reservedInstances

A list of Reserved Instances.

Class com.amazonaws.services.ec2.model.DescribeRouteTablesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• association.route-table-association-id - The ID of an association ID for the route table.

• association.route-table-id - The ID of the route table involved in the association.

• association.subnet-id - The ID of the subnet involved in the association.

• association.main - Indicates whether the route table is the main route table for the VPC (true | false).

• route-table-id - The ID of the route table.

• route.destination-cidr-block - The CIDR range specified in a route in the table.

• route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the table.

• route.gateway-id - The ID of a gateway specified in a route in the table.

• route.instance-id - The ID of an instance specified in a route in the table.

• route.nat-gateway-id - The ID of a NAT gateway.

• route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

• route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).

• route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• vpc-id - The ID of the VPC for the route table.

routeTableIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> routeTableIds

One or more route table IDs.

Default: Describes all your route tables.

Class com.amazonaws.services.ec2.model.DescribeRouteTablesResult extends java.lang.Object implements Serializable

Serialized Fields

routeTables

com.amazonaws.internal.ListWithAutoConstructFlag<RouteTable> routeTables

Information about one or more route tables.

Class com.amazonaws.services.ec2.model.DescribeScheduledInstanceAvailabilityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• availability-zone - The Availability Zone (for example, us-west-2a).

• instance-type - The instance type (for example, c4.large).

• network-platform - The network platform (EC2-Classic or EC2-VPC).

• platform - The platform (Linux/UNIX or Windows).

firstSlotStartTimeRange

SlotDateTimeRangeRequest firstSlotStartTimeRange

The time period for the first schedule to start.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned NextToken value.

maxSlotDurationInHours

java.lang.Integer maxSlotDurationInHours

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

minSlotDurationInHours

java.lang.Integer minSlotDurationInHours

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

nextToken

java.lang.String nextToken

The token for the next set of results.

recurrence

ScheduledInstanceRecurrenceRequest recurrence

The schedule recurrence.

Class com.amazonaws.services.ec2.model.DescribeScheduledInstanceAvailabilityResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token required to retrieve the next set of results. This value is null when there are no more results to return.

scheduledInstanceAvailabilitySet

com.amazonaws.internal.ListWithAutoConstructFlag<ScheduledInstanceAvailability> scheduledInstanceAvailabilitySet

Information about the available Scheduled Instances.

Class com.amazonaws.services.ec2.model.DescribeScheduledInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• availability-zone - The Availability Zone (for example, us-west-2a).

• instance-type - The instance type (for example, c4.large).

• network-platform - The network platform (EC2-Classic or EC2-VPC).

• platform - The platform (Linux/UNIX or Windows).

maxResults

java.lang.Integer maxResults

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken

java.lang.String nextToken

The token for the next set of results.

scheduledInstanceIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> scheduledInstanceIds

One or more Scheduled Instance IDs.

slotStartTimeRange

SlotStartTimeRangeRequest slotStartTimeRange

The time period for the first schedule to start.

Class com.amazonaws.services.ec2.model.DescribeScheduledInstancesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token required to retrieve the next set of results. This value is null when there are no more results to return.

scheduledInstanceSet

com.amazonaws.internal.ListWithAutoConstructFlag<ScheduledInstance> scheduledInstanceSet

Information about the Scheduled Instances.

Class com.amazonaws.services.ec2.model.DescribeSecurityGroupReferencesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupId

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> groupId

One or more security group IDs in your account.

Class com.amazonaws.services.ec2.model.DescribeSecurityGroupReferencesResult extends java.lang.Object implements Serializable

Serialized Fields

securityGroupReferenceSet

com.amazonaws.internal.ListWithAutoConstructFlag<SecurityGroupReference> securityGroupReferenceSet

Information about the VPCs with the referencing security groups.

Class com.amazonaws.services.ec2.model.DescribeSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

• description - The description of the security group.

• egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which the security group allows access.

• group-id - The ID of the security group.

• group-name - The name of the security group.

• ip-permission.cidr - A CIDR range that has been granted permission.

• ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.

• ip-permission.group-id - The ID of a security group that has been granted permission.

• ip-permission.group-name - The name of a security group that has been granted permission.

• ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).

• ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.

• ip-permission.user-id - The ID of an AWS account that has been granted permission.

• owner-id - The AWS account ID of the owner of the security group.

• tag-key - The key of a tag assigned to the security group.

• tag-value - The value of a tag assigned to the security group.

• vpc-id - The ID of the VPC specified when the security group was created.

groupIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> groupIds

One or more security group IDs. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

groupNames

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> groupNames

[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

Class com.amazonaws.services.ec2.model.DescribeSecurityGroupsResult extends java.lang.Object implements Serializable

Serialized Fields

securityGroups

com.amazonaws.internal.ListWithAutoConstructFlag<SecurityGroup> securityGroups

Information about one or more security groups.

Class com.amazonaws.services.ec2.model.DescribeSnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

java.lang.String attribute

The snapshot attribute you would like to view.

Constraints:
Allowed Values: productCodes, createVolumePermission

snapshotId

java.lang.String snapshotId

The ID of the EBS snapshot.

Class com.amazonaws.services.ec2.model.DescribeSnapshotAttributeResult extends java.lang.Object implements Serializable

Serialized Fields

createVolumePermissions

com.amazonaws.internal.ListWithAutoConstructFlag<CreateVolumePermission> createVolumePermissions

A list of permissions for creating volumes from the snapshot.

productCodes

com.amazonaws.internal.ListWithAutoConstructFlag<ProductCode> productCodes

A list of product codes.

snapshotId

java.lang.String snapshotId

The ID of the EBS snapshot.

Class com.amazonaws.services.ec2.model.DescribeSnapshotsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• description - A description of the snapshot.

• owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

• owner-id - The ID of the AWS account that owns the snapshot.

• progress - The progress of the snapshot, as a percentage (for example, 80%).

• snapshot-id - The snapshot ID.

• start-time - The time stamp when the snapshot was initiated.

• status - The status of the snapshot (pending | completed | error).

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• volume-id - The ID of the volume the snapshot is for.

• volume-size - The size of the volume, in GiB.

maxResults

java.lang.Integer maxResults

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

nextToken

java.lang.String nextToken

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

ownerIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> ownerIds

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

restorableByUserIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> restorableByUserIds

One or more AWS accounts IDs that can create volumes from the snapshot.

snapshotIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> snapshotIds

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

Class com.amazonaws.services.ec2.model.DescribeSnapshotsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

snapshots

com.amazonaws.internal.ListWithAutoConstructFlag<Snapshot> snapshots

Information about the snapshots.

Class com.amazonaws.services.ec2.model.DescribeSpotDatafeedSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.ec2.model.DescribeSpotDatafeedSubscriptionResult extends java.lang.Object implements Serializable

Serialized Fields

spotDatafeedSubscription

SpotDatafeedSubscription spotDatafeedSubscription

The Spot instance data feed subscription.

Class com.amazonaws.services.ec2.model.DescribeSpotFleetInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken

java.lang.String nextToken

The token for the next set of results.

spotFleetRequestId

java.lang.String spotFleetRequestId

The ID of the Spot fleet request.

Class com.amazonaws.services.ec2.model.DescribeSpotFleetInstancesResult extends java.lang.Object implements Serializable

Serialized Fields

activeInstances

com.amazonaws.internal.ListWithAutoConstructFlag<ActiveInstance> activeInstances

The running instances. Note that this list is refreshed periodically and might be out of date.

nextToken

java.lang.String nextToken

The token required to retrieve the next set of results. This value is null when there are no more results to return.

spotFleetRequestId

java.lang.String spotFleetRequestId

The ID of the Spot fleet request.

Class com.amazonaws.services.ec2.model.DescribeSpotFleetRequestHistoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

eventType

java.lang.String eventType

The type of events to describe. By default, all events are described.

Constraints:
Allowed Values: instanceChange, fleetRequestChange, error

maxResults

java.lang.Integer maxResults

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken

java.lang.String nextToken

The token for the next set of results.

spotFleetRequestId

java.lang.String spotFleetRequestId

The ID of the Spot fleet request.

startTime

java.util.Date startTime

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Class com.amazonaws.services.ec2.model.DescribeSpotFleetRequestHistoryResult extends java.lang.Object implements Serializable

Serialized Fields

historyRecords

com.amazonaws.internal.ListWithAutoConstructFlag<HistoryRecord> historyRecords

Information about the events in the history of the Spot fleet request.

lastEvaluatedTime

java.util.Date lastEvaluatedTime

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.

If nextToken indicates that there are more results, this value is not present.

nextToken

java.lang.String nextToken

The token required to retrieve the next set of results. This value is null when there are no more results to return.

spotFleetRequestId

java.lang.String spotFleetRequestId

The ID of the Spot fleet request.

startTime

java.util.Date startTime

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Class com.amazonaws.services.ec2.model.DescribeSpotFleetRequestsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken

java.lang.String nextToken

The token for the next set of results.

spotFleetRequestIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> spotFleetRequestIds

The IDs of the Spot fleet requests.

Class com.amazonaws.services.ec2.model.DescribeSpotFleetRequestsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token required to retrieve the next set of results. This value is null when there are no more results to return.

spotFleetRequestConfigs

com.amazonaws.internal.ListWithAutoConstructFlag<SpotFleetRequestConfig> spotFleetRequestConfigs

Information about the configuration of your Spot fleet.

Class com.amazonaws.services.ec2.model.DescribeSpotInstanceRequestsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• availability-zone-group - The Availability Zone group.

• create-time - The time stamp when the Spot instance request was created.

• fault-code - The fault code related to the request.

• fault-message - The fault message related to the request.

• instance-id - The ID of the instance that fulfilled the request.

• launch-group - The Spot instance launch group.

• launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.

• launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

• launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

• launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.

• launch.block-device-mapping.volume-type - The type of the Amazon EBS volume: gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.

• launch.group-id - The security group for the instance.

• launch.image-id - The ID of the AMI.

• launch.instance-type - The type of instance (for example, m3.medium).

• launch.kernel-id - The kernel ID.

• launch.key-name - The name of the key pair the instance launched with.

• launch.monitoring-enabled - Whether monitoring is enabled for the Spot instance.

• launch.ramdisk-id - The RAM disk ID.

• network-interface.network-interface-id - The ID of the network interface.

• network-interface.device-index - The index of the device for the network interface attachment on the instance.

• network-interface.subnet-id - The ID of the subnet for the instance.

• network-interface.description - A description of the network interface.

• network-interface.private-ip-address - The primary private IP address of the network interface.

• network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

• network-interface.group-id - The ID of the security group associated with the network interface.

• network-interface.group-name - The name of the security group associated with the network interface.

• network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

• product-description - The product description associated with the instance (Linux/UNIX | Windows).

• spot-instance-request-id - The Spot instance request ID.

• spot-price - The maximum hourly price for any Spot instance launched to fulfill the request.

• state - The state of the Spot instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

• status-code - The short code describing the most recent evaluation of your Spot instance request.

• status-message - The message explaining the status of the Spot instance request.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• type - The type of Spot instance request (one-time | persistent).

• launched-availability-zone - The Availability Zone in which the bid is launched.

• valid-from - The start date of the request.

• valid-until - The end date of the request.

spotInstanceRequestIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> spotInstanceRequestIds

One or more Spot instance request IDs.

Class com.amazonaws.services.ec2.model.DescribeSpotInstanceRequestsResult extends java.lang.Object implements Serializable

Serialized Fields

spotInstanceRequests

com.amazonaws.internal.ListWithAutoConstructFlag<SpotInstanceRequest> spotInstanceRequests

One or more Spot instance requests.

Class com.amazonaws.services.ec2.model.DescribeSpotPriceHistoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

Filters the results by the specified Availability Zone.

endTime

java.util.Date endTime

The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• availability-zone - The Availability Zone for which prices should be returned.

• instance-type - The type of instance (for example, m3.medium).

• product-description - The product description for the Spot price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

• spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

• timestamp - The timestamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

instanceTypes

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> instanceTypes

Filters the results by the specified instance types.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken

java.lang.String nextToken

The token for the next set of results.

productDescriptions

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> productDescriptions

Filters the results by the specified basic product descriptions.

startTime

java.util.Date startTime

The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Class com.amazonaws.services.ec2.model.DescribeSpotPriceHistoryResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token required to retrieve the next set of results. This value is null when there are no more results to return.

spotPriceHistory

com.amazonaws.internal.ListWithAutoConstructFlag<SpotPrice> spotPriceHistory

The historical Spot prices.

Class com.amazonaws.services.ec2.model.DescribeStaleSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraints:
Range: 5 - 255

nextToken

java.lang.String nextToken

The token for the next set of items to return. (You received this token from a prior call.)

Constraints:
Length: 1 - 1024

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.DescribeStaleSecurityGroupsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

staleSecurityGroupSet

com.amazonaws.internal.ListWithAutoConstructFlag<StaleSecurityGroup> staleSecurityGroupSet

Information about the stale security groups.

Class com.amazonaws.services.ec2.model.DescribeSubnetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

• available-ip-address-count - The number of IP addresses in the subnet that are available.

• cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.

• defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

• state - The state of the subnet (pending | available).

• subnet-id - The ID of the subnet.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• vpc-id - The ID of the VPC for the subnet.

subnetIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> subnetIds

One or more subnet IDs.

Default: Describes all your subnets.

Class com.amazonaws.services.ec2.model.DescribeSubnetsResult extends java.lang.Object implements Serializable

Serialized Fields

subnets

com.amazonaws.internal.ListWithAutoConstructFlag<Subnet> subnets

Information about one or more subnets.

Class com.amazonaws.services.ec2.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• key - The tag key.

• resource-id - The resource ID.

• resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

• value - The tag value.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.

nextToken

java.lang.String nextToken

The token to retrieve the next page of results.

Class com.amazonaws.services.ec2.model.DescribeTagsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return..

tags

com.amazonaws.internal.ListWithAutoConstructFlag<TagDescription> tags

A list of tags.

Class com.amazonaws.services.ec2.model.DescribeVolumeAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

java.lang.String attribute

The instance attribute.

Constraints:
Allowed Values: autoEnableIO, productCodes

volumeId

java.lang.String volumeId

The ID of the volume.

Class com.amazonaws.services.ec2.model.DescribeVolumeAttributeResult extends java.lang.Object implements Serializable

Serialized Fields

autoEnableIO

java.lang.Boolean autoEnableIO

The state of autoEnableIO attribute.

productCodes

com.amazonaws.internal.ListWithAutoConstructFlag<ProductCode> productCodes

A list of product codes.

volumeId

java.lang.String volumeId

The ID of the volume.

Class com.amazonaws.services.ec2.model.DescribeVolumesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• attachment.attach-time - The time stamp when the attachment initiated.

• attachment.delete-on-termination - Whether the volume is deleted on instance termination.

• attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).

• attachment.instance-id - The ID of the instance the volume is attached to.

• attachment.status - The attachment state (attaching | attached | detaching | detached).

• availability-zone - The Availability Zone in which the volume was created.

• create-time - The time stamp when the volume was created.

• encrypted - The encryption status of the volume.

• size - The size of the volume, in GiB.

• snapshot-id - The snapshot from which the volume was created.

• status - The status of the volume (creating | available | in-use | deleting | deleted | error).

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• volume-id - The volume ID.

• volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

maxResults

java.lang.Integer maxResults

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

nextToken

java.lang.String nextToken

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

volumeIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> volumeIds

One or more volume IDs.

Class com.amazonaws.services.ec2.model.DescribeVolumesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

volumes

com.amazonaws.internal.ListWithAutoConstructFlag<Volume> volumes

Information about the volumes.

Class com.amazonaws.services.ec2.model.DescribeVolumeStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• action.code - The action code for the event (for example, enable-volume-io).

• action.description - A description of the action.

• action.event-id - The event ID associated with the action.

• availability-zone - The Availability Zone of the instance.

• event.description - A description of the event.

• event.event-id - The event ID.

• event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

• event.not-after - The latest end time for the event.

• event.not-before - The earliest start time for the event.

• volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

• volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

• volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

maxResults

java.lang.Integer maxResults

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

nextToken

java.lang.String nextToken

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

volumeIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> volumeIds

One or more volume IDs.

Default: Describes all your volumes.

Class com.amazonaws.services.ec2.model.DescribeVolumeStatusResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

volumeStatuses

com.amazonaws.internal.ListWithAutoConstructFlag<VolumeStatusItem> volumeStatuses

A list of volumes.

Class com.amazonaws.services.ec2.model.DescribeVpcAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

java.lang.String attribute

The VPC attribute.

Constraints:
Allowed Values: enableDnsSupport, enableDnsHostnames

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.DescribeVpcAttributeResult extends java.lang.Object implements Serializable

Serialized Fields

enableDnsHostnames

java.lang.Boolean enableDnsHostnames

Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

enableDnsSupport

java.lang.Boolean enableDnsSupport

Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.DescribeVpcClassicLinkDnsSupportRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraints:
Range: 5 - 255

nextToken

java.lang.String nextToken

The token for the next set of items to return. (You received this token from a prior call.)

Constraints:
Length: 1 - 1024

vpcIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> vpcIds

One or more VPC IDs.

Class com.amazonaws.services.ec2.model.DescribeVpcClassicLinkDnsSupportResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use when requesting the next set of items.

Constraints:
Length: 1 - 1024

vpcs

com.amazonaws.internal.ListWithAutoConstructFlag<ClassicLinkDnsSupport> vpcs

Information about the ClassicLink DNS support status of the VPCs.

Class com.amazonaws.services.ec2.model.DescribeVpcClassicLinkRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

vpcIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> vpcIds

One or more VPCs for which you want to describe the ClassicLink status.

Class com.amazonaws.services.ec2.model.DescribeVpcClassicLinkResult extends java.lang.Object implements Serializable

Serialized Fields

vpcs

com.amazonaws.internal.ListWithAutoConstructFlag<VpcClassicLink> vpcs

The ClassicLink status of one or more VPCs.

Class com.amazonaws.services.ec2.model.DescribeVpcEndpointServicesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

nextToken

java.lang.String nextToken

The token for the next set of items to return. (You received this token from a prior call.)

Class com.amazonaws.services.ec2.model.DescribeVpcEndpointServicesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

serviceNames

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> serviceNames

A list of supported AWS services.

Class com.amazonaws.services.ec2.model.DescribeVpcEndpointsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• service-name: The name of the AWS service.

• vpc-id: The ID of the VPC in which the endpoint resides.

• vpc-endpoint-id: The ID of the endpoint.

• vpc-endpoint-state: The state of the endpoint. (pending | available | deleting | deleted)

maxResults

java.lang.Integer maxResults

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

nextToken

java.lang.String nextToken

The token for the next set of items to return. (You received this token from a prior call.)

vpcEndpointIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> vpcEndpointIds

One or more endpoint IDs.

Class com.amazonaws.services.ec2.model.DescribeVpcEndpointsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

vpcEndpoints

com.amazonaws.internal.ListWithAutoConstructFlag<VpcEndpoint> vpcEndpoints

Information about the endpoints.

Class com.amazonaws.services.ec2.model.DescribeVpcPeeringConnectionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• accepter-vpc-info.cidr-block - The CIDR block of the peer VPC.

• accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.

• accepter-vpc-info.vpc-id - The ID of the peer VPC.

• expiration-time - The expiration date and time for the VPC peering connection.

• requester-vpc-info.cidr-block - The CIDR block of the requester's VPC.

• requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

• requester-vpc-info.vpc-id - The ID of the requester VPC.

• status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).

• status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• vpc-peering-connection-id - The ID of the VPC peering connection.

vpcPeeringConnectionIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> vpcPeeringConnectionIds

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

Class com.amazonaws.services.ec2.model.DescribeVpcPeeringConnectionsResult extends java.lang.Object implements Serializable

Serialized Fields

vpcPeeringConnections

com.amazonaws.internal.ListWithAutoConstructFlag<VpcPeeringConnection> vpcPeeringConnections

Information about the VPC peering connections.

Class com.amazonaws.services.ec2.model.DescribeVpcsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• cidr - The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

• dhcp-options-id - The ID of a set of DHCP options.

• isDefault - Indicates whether the VPC is the default VPC.

• state - The state of the VPC (pending | available).

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• vpc-id - The ID of the VPC.

vpcIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> vpcIds

One or more VPC IDs.

Default: Describes all your VPCs.

Class com.amazonaws.services.ec2.model.DescribeVpcsResult extends java.lang.Object implements Serializable

Serialized Fields

vpcs

com.amazonaws.internal.ListWithAutoConstructFlag<Vpc> vpcs

Information about one or more VPCs.

Class com.amazonaws.services.ec2.model.DescribeVpnConnectionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• customer-gateway-configuration - The configuration information for the customer gateway.

• customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

• state - The state of the VPN connection (pending | available | deleting | deleted).

• option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

• route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

• bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• type - The type of VPN connection. Currently the only supported type is ipsec.1.

• vpn-connection-id - The ID of the VPN connection.

• vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

vpnConnectionIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> vpnConnectionIds

One or more VPN connection IDs.

Default: Describes your VPN connections.

Class com.amazonaws.services.ec2.model.DescribeVpnConnectionsResult extends java.lang.Object implements Serializable

Serialized Fields

vpnConnections

com.amazonaws.internal.ListWithAutoConstructFlag<VpnConnection> vpnConnections

Information about one or more VPN connections.

Class com.amazonaws.services.ec2.model.DescribeVpnGatewaysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.ListWithAutoConstructFlag<Filter> filters

One or more filters.

• attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

• attachment.vpc-id - The ID of an attached VPC.

• availability-zone - The Availability Zone for the virtual private gateway (if applicable).

• state - The state of the virtual private gateway (pending | available | deleting | deleted).

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

• vpn-gateway-id - The ID of the virtual private gateway.

vpnGatewayIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> vpnGatewayIds

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

Class com.amazonaws.services.ec2.model.DescribeVpnGatewaysResult extends java.lang.Object implements Serializable

Serialized Fields

vpnGateways

com.amazonaws.internal.ListWithAutoConstructFlag<VpnGateway> vpnGateways

Information about one or more virtual private gateways.

Class com.amazonaws.services.ec2.model.DetachClassicLinkVpcRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The ID of the instance to unlink from the VPC.

vpcId

java.lang.String vpcId

The ID of the VPC to which the instance is linked.

Class com.amazonaws.services.ec2.model.DetachClassicLinkVpcResult extends java.lang.Object implements Serializable

Serialized Fields

returnValue

java.lang.Boolean returnValue

Returns true if the request succeeds; otherwise, it returns an error.

Class com.amazonaws.services.ec2.model.DetachInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

internetGatewayId

java.lang.String internetGatewayId

The ID of the Internet gateway.

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.DetachNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attachmentId

java.lang.String attachmentId

The ID of the attachment.

force

java.lang.Boolean force

Specifies whether to force a detachment.

Class com.amazonaws.services.ec2.model.DetachVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

device

java.lang.String device

The device name.

force

java.lang.Boolean force

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

instanceId

java.lang.String instanceId

The ID of the instance.

volumeId

java.lang.String volumeId

The ID of the volume.

Class com.amazonaws.services.ec2.model.DetachVolumeResult extends java.lang.Object implements Serializable

Serialized Fields

attachment

VolumeAttachment attachment

Information about the volume attachment.

Class com.amazonaws.services.ec2.model.DetachVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

java.lang.String vpcId

The ID of the VPC.

vpnGatewayId

java.lang.String vpnGatewayId

The ID of the virtual private gateway.

Class com.amazonaws.services.ec2.model.DhcpConfiguration extends java.lang.Object implements Serializable

Serialized Fields

key

java.lang.String key

The name of a DHCP option.

values

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> values

One or more values for the DHCP option.

Class com.amazonaws.services.ec2.model.DhcpOptions extends java.lang.Object implements Serializable

Serialized Fields

dhcpConfigurations

com.amazonaws.internal.ListWithAutoConstructFlag<DhcpConfiguration> dhcpConfigurations

One or more DHCP options in the set.

dhcpOptionsId

java.lang.String dhcpOptionsId

The ID of the set of DHCP options.

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the DHCP options set.

Class com.amazonaws.services.ec2.model.DisableVgwRoutePropagationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayId

java.lang.String gatewayId

The ID of the virtual private gateway.

routeTableId

java.lang.String routeTableId

The ID of the route table.

Class com.amazonaws.services.ec2.model.DisableVpcClassicLinkDnsSupportRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.DisableVpcClassicLinkDnsSupportResult extends java.lang.Object implements Serializable

Serialized Fields

returnValue

java.lang.Boolean returnValue

Returns true if the request succeeds; otherwise, it returns an error.

Class com.amazonaws.services.ec2.model.DisableVpcClassicLinkRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.DisableVpcClassicLinkResult extends java.lang.Object implements Serializable

Serialized Fields

returnValue

java.lang.Boolean returnValue

Returns true if the request succeeds; otherwise, it returns an error.

Class com.amazonaws.services.ec2.model.DisassociateAddressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

associationId

java.lang.String associationId

[EC2-VPC] The association ID. Required for EC2-VPC.

publicIp

java.lang.String publicIp

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

Class com.amazonaws.services.ec2.model.DisassociateRouteTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

associationId

java.lang.String associationId

The association ID representing the current association between the route table and subnet.

Class com.amazonaws.services.ec2.model.DiskImage extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

A description of the disk image.

image

DiskImageDetail image

Information about the disk image.

volume

VolumeDetail volume

Information about the volume.

Class com.amazonaws.services.ec2.model.DiskImageDescription extends java.lang.Object implements Serializable

Serialized Fields

checksum

java.lang.String checksum

The checksum computed for the disk image.

format

java.lang.String format

The disk image format.

Constraints:
Allowed Values: VMDK, RAW, VHD

importManifestUrl

java.lang.String importManifestUrl

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

size

java.lang.Long size

The size of the disk image, in GiB.

Class com.amazonaws.services.ec2.model.DiskImageDetail extends java.lang.Object implements Serializable

Serialized Fields

bytes

java.lang.Long bytes

The size of the disk image, in GiB.

format

java.lang.String format

The disk image format.

Constraints:
Allowed Values: VMDK, RAW, VHD

importManifestUrl

java.lang.String importManifestUrl

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

Class com.amazonaws.services.ec2.model.DiskImageVolumeDescription extends java.lang.Object implements Serializable

Serialized Fields

id

java.lang.String id

The volume identifier.

size

java.lang.Long size

The size of the volume, in GiB.

Class com.amazonaws.services.ec2.model.EbsBlockDevice extends java.lang.Object implements Serializable

Serialized Fields

deleteOnTermination

java.lang.Boolean deleteOnTermination

Indicates whether the EBS volume is deleted on instance termination.

encrypted

java.lang.Boolean encrypted

Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

iops

java.lang.Integer iops

The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

snapshotId

java.lang.String snapshotId

The ID of the snapshot.

volumeSize

java.lang.Integer volumeSize

The size of the volume, in GiB.

Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

volumeType

java.lang.String volumeType

The volume type: gp2, io1, st1, sc1, or standard.

Default: standard

Constraints:
Allowed Values: standard, io1, gp2, sc1, st1

Class com.amazonaws.services.ec2.model.EbsInstanceBlockDevice extends java.lang.Object implements Serializable

Serialized Fields

attachTime

java.util.Date attachTime

The time stamp when the attachment initiated.

deleteOnTermination

java.lang.Boolean deleteOnTermination

Indicates whether the volume is deleted on instance termination.

status

java.lang.String status

The attachment state.

Constraints:
Allowed Values: attaching, attached, detaching, detached

volumeId

java.lang.String volumeId

The ID of the EBS volume.

Class com.amazonaws.services.ec2.model.EbsInstanceBlockDeviceSpecification extends java.lang.Object implements Serializable

Serialized Fields

deleteOnTermination

java.lang.Boolean deleteOnTermination

Indicates whether the volume is deleted on instance termination.

volumeId

java.lang.String volumeId

The ID of the EBS volume.

Class com.amazonaws.services.ec2.model.EnableVgwRoutePropagationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayId

java.lang.String gatewayId

The ID of the virtual private gateway.

routeTableId

java.lang.String routeTableId

The ID of the route table.

Class com.amazonaws.services.ec2.model.EnableVolumeIORequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeId

java.lang.String volumeId

The ID of the volume.

Class com.amazonaws.services.ec2.model.EnableVpcClassicLinkDnsSupportRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.EnableVpcClassicLinkDnsSupportResult extends java.lang.Object implements Serializable

Serialized Fields

returnValue

java.lang.Boolean returnValue

Returns true if the request succeeds; otherwise, it returns an error.

Class com.amazonaws.services.ec2.model.EnableVpcClassicLinkRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.EnableVpcClassicLinkResult extends java.lang.Object implements Serializable

Serialized Fields

returnValue

java.lang.Boolean returnValue

Returns true if the request succeeds; otherwise, it returns an error.

Class com.amazonaws.services.ec2.model.EventInformation extends java.lang.Object implements Serializable

Serialized Fields

eventDescription

java.lang.String eventDescription

The description of the event.

eventSubType

java.lang.String eventSubType

The event.

The following are the error events.

• iamFleetRoleInvalid - The Spot fleet did not have the required permissions either to launch or terminate an instance.

• launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.

• spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.

• spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot instances that you can launch.

The following are the fleetRequestChange events.

• active - The Spot fleet has been validated and Amazon EC2 is attempting to maintain the target number of running Spot instances.

• cancelled - The Spot fleet is canceled and has no running Spot instances. The Spot fleet will be deleted two days after its instances were terminated.

• cancelled_running - The Spot fleet is canceled and will not launch additional Spot instances, but its existing Spot instances continue to run until they are interrupted or terminated.

• cancelled_terminating - The Spot fleet is canceled and its Spot instances are terminating.

• expired - The Spot fleet request has expired. A subsequent event indicates that the instances were terminated, if the request was created with TerminateInstancesWithExpiration set.

• modify_in_progress - A request to modify the Spot fleet request was accepted and is in progress.

• modify_successful - The Spot fleet request was modified.

• price_update - The bid price for a launch configuration was adjusted because it was too high. This change is permanent.

• submitted - The Spot fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of Spot instances.

The following are the instanceChange events.

• launched - A bid was fulfilled and a new instance was launched.

• terminated - An instance was terminated by the user.

instanceId

java.lang.String instanceId

The ID of the instance. This information is available only for instanceChange events.

Class com.amazonaws.services.ec2.model.ExportTask extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

A description of the resource being exported.

exportTaskId

java.lang.String exportTaskId

The ID of the export task.

exportToS3Task

ExportToS3Task exportToS3Task

Information about the export task.

instanceExportDetails

InstanceExportDetails instanceExportDetails

Information about the instance to export.

state

java.lang.String state

The state of the export task.

Constraints:
Allowed Values: active, cancelling, cancelled, completed

statusMessage

java.lang.String statusMessage

The status message related to the export task.

Class com.amazonaws.services.ec2.model.ExportToS3Task extends java.lang.Object implements Serializable

Serialized Fields

containerFormat

java.lang.String containerFormat

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

Constraints:
Allowed Values: ova

diskImageFormat

java.lang.String diskImageFormat

The format for the exported image.

Constraints:
Allowed Values: VMDK, RAW, VHD

s3Bucket

java.lang.String s3Bucket

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

s3Key

java.lang.String s3Key

The encryption key for your S3 bucket.

Class com.amazonaws.services.ec2.model.ExportToS3TaskSpecification extends java.lang.Object implements Serializable

Serialized Fields

containerFormat

java.lang.String containerFormat

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

Constraints:
Allowed Values: ova

diskImageFormat

java.lang.String diskImageFormat

The format for the exported image.

Constraints:
Allowed Values: VMDK, RAW, VHD

s3Bucket

java.lang.String s3Bucket

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

s3Prefix

java.lang.String s3Prefix

The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

Class com.amazonaws.services.ec2.model.Filter extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the filter. Filter names are case-sensitive.

values

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> values

One or more filter values. Filter values are case-sensitive.

Class com.amazonaws.services.ec2.model.FlowLog extends java.lang.Object implements Serializable

Serialized Fields

creationTime

java.util.Date creationTime

The date and time the flow log was created.

deliverLogsErrorMessage

java.lang.String deliverLogsErrorMessage

Information about the error that occurred. Rate limited indicates that CloudWatch logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of CloudWatch Logs log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.

deliverLogsPermissionArn

java.lang.String deliverLogsPermissionArn

The ARN of the IAM role that posts logs to CloudWatch Logs.

deliverLogsStatus

java.lang.String deliverLogsStatus

The status of the logs delivery (SUCCESS | FAILED).

flowLogId

java.lang.String flowLogId

The flow log ID.

flowLogStatus

java.lang.String flowLogStatus

The status of the flow log (ACTIVE).

logGroupName

java.lang.String logGroupName

The name of the flow log group.

resourceId

java.lang.String resourceId

The ID of the resource on which the flow log was created.

trafficType

java.lang.String trafficType

The type of traffic captured for the flow log.

Constraints:
Allowed Values: ACCEPT, REJECT, ALL

Class com.amazonaws.services.ec2.model.GetConsoleOutputRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The ID of the instance.

Class com.amazonaws.services.ec2.model.GetConsoleOutputResult extends java.lang.Object implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The ID of the instance.

output

java.lang.String output

The console output, base64-encoded. If using a command line tool, the tools decode the output for you.

timestamp

java.util.Date timestamp

The time the output was last updated.

Class com.amazonaws.services.ec2.model.GetConsoleScreenshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The ID of the instance.

wakeUp

java.lang.Boolean wakeUp

When set to true, acts as keystroke input and wakes up an instance that's in standby or "sleep" mode.

Class com.amazonaws.services.ec2.model.GetConsoleScreenshotResult extends java.lang.Object implements Serializable

Serialized Fields

imageData

java.lang.String imageData

The data that comprises the image.

instanceId

java.lang.String instanceId

The ID of the instance.

Class com.amazonaws.services.ec2.model.GetPasswordDataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The ID of the Windows instance.

Class com.amazonaws.services.ec2.model.GetPasswordDataResult extends java.lang.Object implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The ID of the Windows instance.

passwordData

java.lang.String passwordData

The password of the instance.

timestamp

java.util.Date timestamp

The time the data was last updated.

Class com.amazonaws.services.ec2.model.GroupIdentifier extends java.lang.Object implements Serializable

Serialized Fields

groupId

java.lang.String groupId

The ID of the security group.

groupName

java.lang.String groupName

The name of the security group.

Class com.amazonaws.services.ec2.model.HistoryRecord extends java.lang.Object implements Serializable

Serialized Fields

eventInformation

EventInformation eventInformation

Information about the event.

eventType

java.lang.String eventType

The event type.

• error - Indicates an error with the Spot fleet request.

• fleetRequestChange - Indicates a change in the status or configuration of the Spot fleet request.

• instanceChange - Indicates that an instance was launched or terminated.

Constraints:
Allowed Values: instanceChange, fleetRequestChange, error

timestamp

java.util.Date timestamp

The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Class com.amazonaws.services.ec2.model.Host extends java.lang.Object implements Serializable

Serialized Fields

autoPlacement

java.lang.String autoPlacement

Whether auto-placement is on or off.

Constraints:
Allowed Values: on, off

availabilityZone

java.lang.String availabilityZone

The Availability Zone of the Dedicated host.

availableCapacity

AvailableCapacity availableCapacity

The number of new instances that can be launched onto the Dedicated host.

clientToken

java.lang.String clientToken

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

hostId

java.lang.String hostId

The ID of the Dedicated host.

hostProperties

HostProperties hostProperties

The hardware specifications of the Dedicated host.

hostReservationId

java.lang.String hostReservationId

The reservation ID of the Dedicated host. This returns a null response if the Dedicated host doesn't have an associated reservation.

instances

com.amazonaws.internal.ListWithAutoConstructFlag<HostInstance> instances

The IDs and instance type that are currently running on the Dedicated host.

state

java.lang.String state

The Dedicated host's state.

Constraints:
Allowed Values: available, under-assessment, permanent-failure, released, released-permanent-failure

Class com.amazonaws.services.ec2.model.HostInstance extends java.lang.Object implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

the IDs of instances that are running on the Dedicated host.

instanceType

java.lang.String instanceType

The instance type size (for example, m3.medium) of the running instance.

Class com.amazonaws.services.ec2.model.HostProperties extends java.lang.Object implements Serializable

Serialized Fields

cores

java.lang.Integer cores

The number of cores on the Dedicated host.

instanceType

java.lang.String instanceType

The instance type size that the Dedicated host supports (for example, m3.medium).

sockets

java.lang.Integer sockets

The number of sockets on the Dedicated host.

totalVCpus

java.lang.Integer totalVCpus

The number of vCPUs on the Dedicated host.

Class com.amazonaws.services.ec2.model.IamInstanceProfile extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the instance profile.

id

java.lang.String id

The ID of the instance profile.

Class com.amazonaws.services.ec2.model.IamInstanceProfileSpecification extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the instance profile.

name

java.lang.String name

The name of the instance profile.

Class com.amazonaws.services.ec2.model.IcmpTypeCode extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.Integer code

The ICMP type. A value of -1 means all types.

type

java.lang.Integer type

The ICMP code. A value of -1 means all codes for the specified ICMP type.

Class com.amazonaws.services.ec2.model.IdFormat extends java.lang.Object implements Serializable

Serialized Fields

deadline

java.util.Date deadline

The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.

resource

java.lang.String resource

The type of resource.

useLongIds

java.lang.Boolean useLongIds

Indicates whether longer IDs (17-character IDs) are enabled for the resource.

Class com.amazonaws.services.ec2.model.Image extends java.lang.Object implements Serializable

Serialized Fields

architecture

java.lang.String architecture

The architecture of the image.

Constraints:
Allowed Values: i386, x86_64

blockDeviceMappings

com.amazonaws.internal.ListWithAutoConstructFlag<BlockDeviceMapping> blockDeviceMappings

Any block device mapping entries.

creationDate

java.lang.String creationDate

The date and time the image was created.

description

java.lang.String description

The description of the AMI that was provided during image creation.

hypervisor

java.lang.String hypervisor

The hypervisor type of the image.

Constraints:
Allowed Values: ovm, xen

imageId

java.lang.String imageId

The ID of the AMI.

imageLocation

java.lang.String imageLocation

The location of the AMI.

imageOwnerAlias

java.lang.String imageOwnerAlias

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

imageType

java.lang.String imageType

The type of image.

Constraints:
Allowed Values: machine, kernel, ramdisk

kernelId

java.lang.String kernelId

The kernel associated with the image, if any. Only applicable for machine images.

name

java.lang.String name

The name of the AMI that was provided during image creation.

ownerId

java.lang.String ownerId

The AWS account ID of the image owner.

platform

java.lang.String platform

The value is Windows for Windows AMIs; otherwise blank.

Constraints:
Allowed Values: Windows

productCodes

com.amazonaws.internal.ListWithAutoConstructFlag<ProductCode> productCodes

Any product codes associated with the AMI.

publicValue

java.lang.Boolean publicValue

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

ramdiskId

java.lang.String ramdiskId

The RAM disk associated with the image, if any. Only applicable for machine images.

rootDeviceName

java.lang.String rootDeviceName

The device name of the root device (for example, /dev/sda1 or /dev/xvda).

rootDeviceType

java.lang.String rootDeviceType

The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.

Constraints:
Allowed Values: ebs, instance-store

sriovNetSupport

java.lang.String sriovNetSupport

Specifies whether enhanced networking is enabled.

state

java.lang.String state

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

Constraints:
Allowed Values: pending, available, invalid, deregistered, transient, failed, error

stateReason

StateReason stateReason

The reason for the state change.

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the image.

virtualizationType

java.lang.String virtualizationType

The type of virtualization of the AMI.

Constraints:
Allowed Values: hvm, paravirtual

Class com.amazonaws.services.ec2.model.ImageAttribute extends java.lang.Object implements Serializable

Serialized Fields

blockDeviceMappings

com.amazonaws.internal.ListWithAutoConstructFlag<BlockDeviceMapping> blockDeviceMappings

One or more block device mapping entries.

description

java.lang.String description

A description for the AMI.

imageId

java.lang.String imageId

The ID of the AMI.

kernelId

java.lang.String kernelId

The kernel ID.

launchPermissions

com.amazonaws.internal.ListWithAutoConstructFlag<LaunchPermission> launchPermissions

One or more launch permissions.

productCodes

com.amazonaws.internal.ListWithAutoConstructFlag<ProductCode> productCodes

One or more product codes.

ramdiskId

java.lang.String ramdiskId

The RAM disk ID.

sriovNetSupport

java.lang.String sriovNetSupport

The value to use for a resource attribute.

Class com.amazonaws.services.ec2.model.ImageDiskContainer extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

The description of the disk image.

deviceName

java.lang.String deviceName

The block device mapping for the disk.

format

java.lang.String format

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

snapshotId

java.lang.String snapshotId

The ID of the EBS snapshot to be used for importing the snapshot.

url

java.lang.String url

The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)

userBucket

UserBucket userBucket

The S3 bucket for the disk image.

Class com.amazonaws.services.ec2.model.ImportImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

architecture

java.lang.String architecture

The architecture of the virtual machine.

Valid values: i386 | x86_64

clientData

ClientData clientData

The client-specific data.

clientToken

java.lang.String clientToken

The token to enable idempotency for VM import requests.

description

java.lang.String description

A description string for the import image task.

diskContainers

com.amazonaws.internal.ListWithAutoConstructFlag<ImageDiskContainer> diskContainers

Information about the disk containers.

hypervisor

java.lang.String hypervisor

The target hypervisor platform.

Valid values: xen

licenseType

java.lang.String licenseType

The license type to be used for the Amazon Machine Image (AMI) after importing.

Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see VM Import/Export Prerequisites in the Amazon Elastic Compute Cloud User Guide.

Valid values: AWS | BYOL

platform

java.lang.String platform

The operating system of the virtual machine.

Valid values: Windows | Linux

roleName

java.lang.String roleName

The name of the role to use when not using the default role, 'vmimport'.

Class com.amazonaws.services.ec2.model.ImportImageResult extends java.lang.Object implements Serializable

Serialized Fields

architecture

java.lang.String architecture

The architecture of the virtual machine.

description

java.lang.String description

A description of the import task.

hypervisor

java.lang.String hypervisor

The target hypervisor of the import task.

imageId

java.lang.String imageId

The ID of the Amazon Machine Image (AMI) created by the import task.

importTaskId

java.lang.String importTaskId

The task ID of the import image task.

licenseType

java.lang.String licenseType

The license type of the virtual machine.

platform

java.lang.String platform

The operating system of the virtual machine.

progress

java.lang.String progress

The progress of the task.

snapshotDetails

com.amazonaws.internal.ListWithAutoConstructFlag<SnapshotDetail> snapshotDetails

Information about the snapshots.

status

java.lang.String status

A brief status of the task.

statusMessage

java.lang.String statusMessage

A detailed status message of the import task.

Class com.amazonaws.services.ec2.model.ImportImageTask extends java.lang.Object implements Serializable

Serialized Fields

architecture

java.lang.String architecture

The architecture of the virtual machine.

Valid values: i386 | x86_64

description

java.lang.String description

A description of the import task.

hypervisor

java.lang.String hypervisor

The target hypervisor for the import task.

Valid values: xen

imageId

java.lang.String imageId

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

importTaskId

java.lang.String importTaskId

The ID of the import image task.

licenseType

java.lang.String licenseType

The license type of the virtual machine.

platform

java.lang.String platform

The description string for the import image task.

progress

java.lang.String progress

The percentage of progress of the import image task.

snapshotDetails

com.amazonaws.internal.ListWithAutoConstructFlag<SnapshotDetail> snapshotDetails

Information about the snapshots.

status

java.lang.String status

A brief status for the import image task.

statusMessage

java.lang.String statusMessage

A descriptive status message for the import image task.

Class com.amazonaws.services.ec2.model.ImportInstanceLaunchSpecification extends java.lang.Object implements Serializable

Serialized Fields

additionalInfo

java.lang.String additionalInfo

Reserved.

architecture

java.lang.String architecture

The architecture of the instance.

Constraints:
Allowed Values: i386, x86_64

groupIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> groupIds

One or more security group IDs.

groupNames

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> groupNames

One or more security group names.

instanceInitiatedShutdownBehavior

java.lang.String instanceInitiatedShutdownBehavior

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Constraints:
Allowed Values: stop, terminate

instanceType

java.lang.String instanceType

The instance type. For more information about the instance types that you can import, see Before You Get Started in the Amazon Elastic Compute Cloud User Guide.

Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge

monitoring

java.lang.Boolean monitoring

Indicates whether monitoring is enabled.

placement

Placement placement

The placement information for the instance.

privateIpAddress

java.lang.String privateIpAddress

[EC2-VPC] An available IP address from the IP address range of the subnet.

subnetId

java.lang.String subnetId

[EC2-VPC] The ID of the subnet in which to launch the instance.

userData

UserData userData

The Base64-encoded MIME user data to be made available to the instance.

Class com.amazonaws.services.ec2.model.ImportInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

A description for the instance being imported.

diskImages

com.amazonaws.internal.ListWithAutoConstructFlag<DiskImage> diskImages

The disk image.

launchSpecification

ImportInstanceLaunchSpecification launchSpecification

The launch specification.

platform

java.lang.String platform

The instance operating system.

Constraints:
Allowed Values: Windows

Class com.amazonaws.services.ec2.model.ImportInstanceResult extends java.lang.Object implements Serializable

Serialized Fields

conversionTask

ConversionTask conversionTask

Information about the conversion task.

Class com.amazonaws.services.ec2.model.ImportInstanceTaskDetails extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

A description of the task.

instanceId

java.lang.String instanceId

The ID of the instance.

platform

java.lang.String platform

The instance operating system.

Constraints:
Allowed Values: Windows

volumes

com.amazonaws.internal.ListWithAutoConstructFlag<ImportInstanceVolumeDetailItem> volumes

One or more volumes.

Class com.amazonaws.services.ec2.model.ImportInstanceVolumeDetailItem extends java.lang.Object implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone where the resulting instance will reside.

bytesConverted

java.lang.Long bytesConverted

The number of bytes converted so far.

description

java.lang.String description

A description of the task.

image

DiskImageDescription image

The image.

status

java.lang.String status

The status of the import of this particular disk image.

statusMessage

java.lang.String statusMessage

The status information or errors related to the disk image.

volume

DiskImageVolumeDescription volume

The volume.

Class com.amazonaws.services.ec2.model.ImportKeyPairRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyName

java.lang.String keyName

A unique name for the key pair.

publicKeyMaterial

java.lang.String publicKeyMaterial

The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.

Class com.amazonaws.services.ec2.model.ImportKeyPairResult extends java.lang.Object implements Serializable

Serialized Fields

keyFingerprint

java.lang.String keyFingerprint

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

keyName

java.lang.String keyName

The key pair name you provided.

Class com.amazonaws.services.ec2.model.ImportSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientData

ClientData clientData

The client-specific data.

clientToken

java.lang.String clientToken

Token to enable idempotency for VM import requests.

description

java.lang.String description

The description string for the import snapshot task.

diskContainer

SnapshotDiskContainer diskContainer

Information about the disk container.

roleName

java.lang.String roleName

The name of the role to use when not using the default role, 'vmimport'.

Class com.amazonaws.services.ec2.model.ImportSnapshotResult extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

A description of the import snapshot task.

importTaskId

java.lang.String importTaskId

The ID of the import snapshot task.

snapshotTaskDetail

SnapshotTaskDetail snapshotTaskDetail

Information about the import snapshot task.

Class com.amazonaws.services.ec2.model.ImportSnapshotTask extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

A description of the import snapshot task.

importTaskId

java.lang.String importTaskId

The ID of the import snapshot task.

snapshotTaskDetail

SnapshotTaskDetail snapshotTaskDetail

Describes an import snapshot task.

Class com.amazonaws.services.ec2.model.ImportVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone for the resulting EBS volume.

description

java.lang.String description

A description of the volume.

image

DiskImageDetail image

The disk image.

volume

VolumeDetail volume

The volume size.

Class com.amazonaws.services.ec2.model.ImportVolumeResult extends java.lang.Object implements Serializable

Serialized Fields

conversionTask

ConversionTask conversionTask

Information about the conversion task.

Class com.amazonaws.services.ec2.model.ImportVolumeTaskDetails extends java.lang.Object implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone where the resulting volume will reside.

bytesConverted

java.lang.Long bytesConverted

The number of bytes converted so far.

description

java.lang.String description

The description you provided when starting the import volume task.

image

DiskImageDescription image

The image.

volume

DiskImageVolumeDescription volume

The volume.

Class com.amazonaws.services.ec2.model.Instance extends java.lang.Object implements Serializable

Serialized Fields

amiLaunchIndex

java.lang.Integer amiLaunchIndex

The AMI launch index, which can be used to find this instance in the launch group.

architecture

java.lang.String architecture

The architecture of the image.

Constraints:
Allowed Values: i386, x86_64

blockDeviceMappings

com.amazonaws.internal.ListWithAutoConstructFlag<InstanceBlockDeviceMapping> blockDeviceMappings

Any block device mapping entries for the instance.

clientToken

java.lang.String clientToken

The idempotency token you provided when you launched the instance, if applicable.

ebsOptimized

java.lang.Boolean ebsOptimized

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

hypervisor

java.lang.String hypervisor

The hypervisor type of the instance.

Constraints:
Allowed Values: ovm, xen

iamInstanceProfile

IamInstanceProfile iamInstanceProfile

The IAM instance profile associated with the instance, if applicable.

imageId

java.lang.String imageId

The ID of the AMI used to launch the instance.

instanceId

java.lang.String instanceId

The ID of the instance.

instanceLifecycle

java.lang.String instanceLifecycle

Indicates whether this is a Spot instance or a Scheduled Instance.

Constraints:
Allowed Values: spot, scheduled

instanceType

java.lang.String instanceType

The instance type.

Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge

kernelId

java.lang.String kernelId

The kernel associated with this instance, if applicable.

keyName

java.lang.String keyName

The name of the key pair, if this instance was launched with an associated key pair.

launchTime

java.util.Date launchTime

The time the instance was launched.

monitoring

Monitoring monitoring

The monitoring information for the instance.

networkInterfaces

com.amazonaws.internal.ListWithAutoConstructFlag<InstanceNetworkInterface> networkInterfaces

[EC2-VPC] One or more network interfaces for the instance.

placement

Placement placement

The location where the instance launched, if applicable.

platform

java.lang.String platform

The value is Windows for Windows instances; otherwise blank.

Constraints:
Allowed Values: Windows

privateDnsName

java.lang.String privateDnsName

The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

privateIpAddress

java.lang.String privateIpAddress

The private IP address assigned to the instance.

productCodes

com.amazonaws.internal.ListWithAutoConstructFlag<ProductCode> productCodes

The product codes attached to this instance, if applicable.

publicDnsName

java.lang.String publicDnsName

The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

publicIpAddress

java.lang.String publicIpAddress

The public IP address assigned to the instance, if applicable.

ramdiskId

java.lang.String ramdiskId

The RAM disk associated with this instance, if applicable.

rootDeviceName

java.lang.String rootDeviceName

The root device name (for example, /dev/sda1 or /dev/xvda).

rootDeviceType

java.lang.String rootDeviceType

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

Constraints:
Allowed Values: ebs, instance-store

securityGroups

com.amazonaws.internal.ListWithAutoConstructFlag<GroupIdentifier> securityGroups

One or more security groups for the instance.

sourceDestCheck

java.lang.Boolean sourceDestCheck

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

spotInstanceRequestId

java.lang.String spotInstanceRequestId

If the request is a Spot instance request, the ID of the request.

sriovNetSupport

java.lang.String sriovNetSupport

Specifies whether enhanced networking is enabled.

state

InstanceState state

The current state of the instance.

stateReason

StateReason stateReason

The reason for the most recent state transition.

stateTransitionReason

java.lang.String stateTransitionReason

The reason for the most recent state transition. This might be an empty string.

subnetId

java.lang.String subnetId

[EC2-VPC] The ID of the subnet in which the instance is running.

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the instance.

virtualizationType

java.lang.String virtualizationType

The virtualization type of the instance.

Constraints:
Allowed Values: hvm, paravirtual

vpcId

java.lang.String vpcId

[EC2-VPC] The ID of the VPC in which the instance is running.

Class com.amazonaws.services.ec2.model.InstanceAttribute extends java.lang.Object implements Serializable

Serialized Fields

blockDeviceMappings

com.amazonaws.internal.ListWithAutoConstructFlag<InstanceBlockDeviceMapping> blockDeviceMappings

The block device mapping of the instance.

disableApiTermination

java.lang.Boolean disableApiTermination

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

ebsOptimized

java.lang.Boolean ebsOptimized

Indicates whether the instance is optimized for EBS I/O.

groups

com.amazonaws.internal.ListWithAutoConstructFlag<GroupIdentifier> groups

The security groups associated with the instance.

instanceId

java.lang.String instanceId

The ID of the instance.

instanceInitiatedShutdownBehavior

java.lang.String instanceInitiatedShutdownBehavior

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

instanceType

java.lang.String instanceType

The instance type.

kernelId

java.lang.String kernelId

The kernel ID.

productCodes

com.amazonaws.internal.ListWithAutoConstructFlag<ProductCode> productCodes

A list of product codes.

ramdiskId

java.lang.String ramdiskId

The RAM disk ID.

rootDeviceName

java.lang.String rootDeviceName

The name of the root device (for example, /dev/sda1 or /dev/xvda).

sourceDestCheck

java.lang.Boolean sourceDestCheck

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

sriovNetSupport

java.lang.String sriovNetSupport

The value to use for a resource attribute.

userData

java.lang.String userData

The Base64-encoded MIME user data.

Class com.amazonaws.services.ec2.model.InstanceBlockDeviceMapping extends java.lang.Object implements Serializable

Serialized Fields

deviceName

java.lang.String deviceName

The device name exposed to the instance (for example, /dev/sdh or xvdh).

ebs

EbsInstanceBlockDevice ebs

Parameters used to automatically set up EBS volumes when the instance is launched.

Class com.amazonaws.services.ec2.model.InstanceBlockDeviceMappingSpecification extends java.lang.Object implements Serializable

Serialized Fields

deviceName

java.lang.String deviceName

The device name exposed to the instance (for example, /dev/sdh or xvdh).

ebs

EbsInstanceBlockDeviceSpecification ebs

Parameters used to automatically set up EBS volumes when the instance is launched.

noDevice

java.lang.String noDevice

suppress the specified device included in the block device mapping.

virtualName

java.lang.String virtualName

The virtual device name.

Class com.amazonaws.services.ec2.model.InstanceCapacity extends java.lang.Object implements Serializable

Serialized Fields

availableCapacity

java.lang.Integer availableCapacity

The number of instances that can still be launched onto the Dedicated host.

instanceType

java.lang.String instanceType

The instance type size supported by the Dedicated host.

totalCapacity

java.lang.Integer totalCapacity

The total number of instances that can be launched onto the Dedicated host.

Class com.amazonaws.services.ec2.model.InstanceCount extends java.lang.Object implements Serializable

Serialized Fields

instanceCount

java.lang.Integer instanceCount

The number of listed Reserved Instances in the state specified by the state.

state

java.lang.String state

The states of the listed Reserved Instances.

Constraints:
Allowed Values: available, sold, cancelled, pending

Class com.amazonaws.services.ec2.model.InstanceExportDetails extends java.lang.Object implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The ID of the resource being exported.

targetEnvironment

java.lang.String targetEnvironment

The target virtualization environment.

Constraints:
Allowed Values: citrix, vmware, microsoft

Class com.amazonaws.services.ec2.model.InstanceMonitoring extends java.lang.Object implements Serializable

Serialized Fields

instanceId

java.lang.String instanceId

The ID of the instance.

monitoring

Monitoring monitoring

The monitoring information.

Class com.amazonaws.services.ec2.model.InstanceNetworkInterface extends java.lang.Object implements Serializable

Serialized Fields

association

InstanceNetworkInterfaceAssociation association

The association information for an Elastic IP associated with the network interface.

attachment

InstanceNetworkInterfaceAttachment attachment

The network interface attachment.

description

java.lang.String description

The description.

groups

com.amazonaws.internal.ListWithAutoConstructFlag<GroupIdentifier> groups

One or more security groups.

macAddress

java.lang.String macAddress

The MAC address.

networkInterfaceId

java.lang.String networkInterfaceId

The ID of the network interface.

ownerId

java.lang.String ownerId

The ID of the AWS account that created the network interface.

privateDnsName

java.lang.String privateDnsName

The private DNS name.

privateIpAddress

java.lang.String privateIpAddress

The IP address of the network interface within the subnet.

privateIpAddresses

com.amazonaws.internal.ListWithAutoConstructFlag<InstancePrivateIpAddress> privateIpAddresses

The private IP addresses associated with the network interface.

sourceDestCheck

java.lang.Boolean sourceDestCheck

Indicates whether to validate network traffic to or from this network interface.

status

java.lang.String status

The status of the network interface.

Constraints:
Allowed Values: available, attaching, in-use, detaching

subnetId

java.lang.String subnetId

The ID of the subnet.

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.InstanceNetworkInterfaceAssociation extends java.lang.Object implements Serializable

Serialized Fields

ipOwnerId

java.lang.String ipOwnerId

The ID of the owner of the Elastic IP address.

publicDnsName

java.lang.String publicDnsName

The public DNS name.

publicIp

java.lang.String publicIp

The public IP address or Elastic IP address bound to the network interface.

Class com.amazonaws.services.ec2.model.InstanceNetworkInterfaceAttachment extends java.lang.Object implements Serializable

Serialized Fields

attachmentId

java.lang.String attachmentId

The ID of the network interface attachment.

attachTime

java.util.Date attachTime

The time stamp when the attachment initiated.

deleteOnTermination

java.lang.Boolean deleteOnTermination

Indicates whether the network interface is deleted when the instance is terminated.

deviceIndex

java.lang.Integer deviceIndex

The index of the device on the instance for the network interface attachment.

status

java.lang.String status

The attachment state.

Constraints:
Allowed Values: attaching, attached, detaching, detached

Class com.amazonaws.services.ec2.model.InstanceNetworkInterfaceSpecification extends java.lang.Object implements Serializable

Serialized Fields

associatePublicIpAddress

java.lang.Boolean associatePublicIpAddress

Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

deleteOnTermination

java.lang.Boolean deleteOnTermination

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

description

java.lang.String description

The description of the network interface. Applies only if creating a network interface when launching an instance.

deviceIndex

java.lang.Integer deviceIndex

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

groups

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> groups

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

networkInterfaceId

java.lang.String networkInterfaceId

The ID of the network interface.

privateIpAddress

java.lang.String privateIpAddress

The private IP address of the network interface. Applies only if creating a network interface when launching an instance.

privateIpAddresses

com.amazonaws.internal.ListWithAutoConstructFlag<PrivateIpAddressSpecification> privateIpAddresses

One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.

secondaryPrivateIpAddressCount

java.lang.Integer secondaryPrivateIpAddressCount

The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.

subnetId

java.lang.String subnetId

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

Class com.amazonaws.services.ec2.model.InstancePrivateIpAddress extends java.lang.Object implements Serializable

Serialized Fields

association

InstanceNetworkInterfaceAssociation association

The association information for an Elastic IP address for the network interface.

primary

java.lang.Boolean primary

Indicates whether this IP address is the primary private IP address of the network interface.

privateDnsName

java.lang.String privateDnsName

The private DNS name.

privateIpAddress

java.lang.String privateIpAddress

The private IP address of the network interface.

Class com.amazonaws.services.ec2.model.InstanceState extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.Integer code

The low byte represents the state. The high byte is an opaque internal value and should be ignored.

• 0 : pending

• 16 : running

• 32 : shutting-down

• 48 : terminated

• 64 : stopping

• 80 : stopped

name

java.lang.String name

The current state of the instance.

Constraints:
Allowed Values: pending, running, shutting-down, terminated, stopping, stopped

Class com.amazonaws.services.ec2.model.InstanceStateChange extends java.lang.Object implements Serializable

Serialized Fields

currentState

InstanceState currentState

The current state of the instance.

instanceId

java.lang.String instanceId

The ID of the instance.

previousState

InstanceState previousState

The previous state of the instance.

Class com.amazonaws.services.ec2.model.InstanceStatus extends java.lang.Object implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone of the instance.

events

com.amazonaws.internal.ListWithAutoConstructFlag<InstanceStatusEvent> events

Any scheduled events associated with the instance.

instanceId

java.lang.String instanceId

The ID of the instance.

instanceState

InstanceState instanceState

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

instanceStatus

InstanceStatusSummary instanceStatus

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

systemStatus

InstanceStatusSummary systemStatus

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

Class com.amazonaws.services.ec2.model.InstanceStatusDetails extends java.lang.Object implements Serializable

Serialized Fields

impairedSince

java.util.Date impairedSince

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

name

java.lang.String name

The type of instance status.

Constraints:
Allowed Values: reachability

status

java.lang.String status

The status.

Constraints:
Allowed Values: passed, failed, insufficient-data, initializing

Class com.amazonaws.services.ec2.model.InstanceStatusEvent extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.String code

The event code.

Constraints:
Allowed Values: instance-reboot, system-reboot, system-maintenance, instance-retirement, instance-stop

description

java.lang.String description

A description of the event.

After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].

notAfter

java.util.Date notAfter

The latest scheduled end time for the event.

notBefore

java.util.Date notBefore

The earliest scheduled start time for the event.

Class com.amazonaws.services.ec2.model.InstanceStatusSummary extends java.lang.Object implements Serializable

Serialized Fields

details

com.amazonaws.internal.ListWithAutoConstructFlag<InstanceStatusDetails> details

The system instance health or application instance health.

status

java.lang.String status

The status.

Constraints:
Allowed Values: ok, impaired, insufficient-data, not-applicable, initializing

Class com.amazonaws.services.ec2.model.InternetGateway extends java.lang.Object implements Serializable

Serialized Fields

attachments

com.amazonaws.internal.ListWithAutoConstructFlag<InternetGatewayAttachment> attachments

Any VPCs attached to the Internet gateway.

internetGatewayId

java.lang.String internetGatewayId

The ID of the Internet gateway.

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the Internet gateway.

Class com.amazonaws.services.ec2.model.InternetGatewayAttachment extends java.lang.Object implements Serializable

Serialized Fields

state

java.lang.String state

The current state of the attachment.

Constraints:
Allowed Values: attaching, attached, detaching, detached

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.IpPermission extends java.lang.Object implements Serializable

Serialized Fields

fromPort

java.lang.Integer fromPort

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

ipProtocol

java.lang.String ipProtocol

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

[EC2-VPC only] When you authorize or revoke security group rules, you can use -1 to specify all.

ipRanges

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> ipRanges

One or more IP ranges.

prefixListIds

com.amazonaws.internal.ListWithAutoConstructFlag<PrefixListId> prefixListIds

(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

toPort

java.lang.Integer toPort

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

userIdGroupPairs

com.amazonaws.internal.ListWithAutoConstructFlag<UserIdGroupPair> userIdGroupPairs

One or more security group and AWS account ID pairs.

Class com.amazonaws.services.ec2.model.KeyPair extends java.lang.Object implements Serializable

Serialized Fields

keyFingerprint

java.lang.String keyFingerprint

The SHA-1 digest of the DER encoded private key.

keyMaterial

java.lang.String keyMaterial

An unencrypted PEM encoded RSA private key.

keyName

java.lang.String keyName

The name of the key pair.

Class com.amazonaws.services.ec2.model.KeyPairInfo extends java.lang.Object implements Serializable

Serialized Fields

keyFingerprint

java.lang.String keyFingerprint

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

keyName

java.lang.String keyName

The name of the key pair.

Class com.amazonaws.services.ec2.model.LaunchPermission extends java.lang.Object implements Serializable

Serialized Fields

group

java.lang.String group

The name of the group.

Constraints:
Allowed Values: all

userId

java.lang.String userId

The AWS account ID.

Class com.amazonaws.services.ec2.model.LaunchPermissionModifications extends java.lang.Object implements Serializable

Serialized Fields

add

com.amazonaws.internal.ListWithAutoConstructFlag<LaunchPermission> add

The AWS account ID to add to the list of launch permissions for the AMI.

remove

com.amazonaws.internal.ListWithAutoConstructFlag<LaunchPermission> remove

The AWS account ID to remove from the list of launch permissions for the AMI.

Class com.amazonaws.services.ec2.model.LaunchSpecification extends java.lang.Object implements Serializable

Serialized Fields

addressingType

java.lang.String addressingType

Deprecated.

allSecurityGroups

com.amazonaws.internal.ListWithAutoConstructFlag<GroupIdentifier> allSecurityGroups

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

blockDeviceMappings

com.amazonaws.internal.ListWithAutoConstructFlag<BlockDeviceMapping> blockDeviceMappings

One or more block device mapping entries.

Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.

ebsOptimized

java.lang.Boolean ebsOptimized

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

iamInstanceProfile

IamInstanceProfileSpecification iamInstanceProfile

The IAM instance profile.

imageId

java.lang.String imageId

The ID of the AMI.

instanceType

java.lang.String instanceType

The instance type.

Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge

kernelId

java.lang.String kernelId

The ID of the kernel.

keyName

java.lang.String keyName

The name of the key pair.

monitoringEnabled

java.lang.Boolean monitoringEnabled

Enables monitoring for the instance.

Default: Disabled

networkInterfaces

com.amazonaws.internal.ListWithAutoConstructFlag<InstanceNetworkInterfaceSpecification> networkInterfaces

One or more network interfaces.

placement

SpotPlacement placement

The placement information for the instance.

ramdiskId

java.lang.String ramdiskId

The ID of the RAM disk.

securityGroups

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> securityGroups

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

subnetId

java.lang.String subnetId

The ID of the subnet in which to launch the instance.

userData

java.lang.String userData

The Base64-encoded MIME user data to make available to the instances.

Class com.amazonaws.services.ec2.model.ModifyHostsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoPlacement

java.lang.String autoPlacement

Specify whether to enable or disable auto-placement.

Constraints:
Allowed Values: on, off

hostIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> hostIds

The host IDs of the Dedicated hosts you want to modify.

Class com.amazonaws.services.ec2.model.ModifyHostsResult extends java.lang.Object implements Serializable

Serialized Fields

successful

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> successful

The IDs of the Dedicated hosts that were successfully modified.

unsuccessful

com.amazonaws.internal.ListWithAutoConstructFlag<UnsuccessfulItem> unsuccessful

The IDs of the Dedicated hosts that could not be modified. Check whether the setting you requested can be used.

Class com.amazonaws.services.ec2.model.ModifyIdFormatRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resource

java.lang.String resource

The type of resource.

useLongIds

java.lang.Boolean useLongIds

Indicate whether the resource should use longer IDs (17-character IDs).

Class com.amazonaws.services.ec2.model.ModifyImageAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

java.lang.String attribute

The name of the attribute to modify.

description

java.lang.String description

A description for the AMI.

imageId

java.lang.String imageId

The ID of the AMI.

launchPermission

LaunchPermissionModifications launchPermission

A launch permission modification.

operationType

java.lang.String operationType

The operation type.

Constraints:
Allowed Values: add, remove

productCodes

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> productCodes

One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.

userGroups

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> userGroups

One or more user groups. This is only valid when modifying the launchPermission attribute.

userIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> userIds

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

value

java.lang.String value

The value of the attribute being modified. This is only valid when modifying the description attribute.

Class com.amazonaws.services.ec2.model.ModifyInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

java.lang.String attribute

The name of the attribute.

Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport

blockDeviceMappings

com.amazonaws.internal.ListWithAutoConstructFlag<InstanceBlockDeviceMappingSpecification> blockDeviceMappings

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.

disableApiTermination

java.lang.Boolean disableApiTermination

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this paramater for Spot Instances.

ebsOptimized

java.lang.Boolean ebsOptimized

Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

groups

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> groups

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

instanceId

java.lang.String instanceId

The ID of the instance.

instanceInitiatedShutdownBehavior

java.lang.String instanceInitiatedShutdownBehavior

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

instanceType

java.lang.String instanceType

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

kernel

java.lang.String kernel

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

ramdisk

java.lang.String ramdisk

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

sourceDestCheck

java.lang.Boolean sourceDestCheck

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

sriovNetSupport

java.lang.String sriovNetSupport

Set to simple to enable enhanced networking for the instance.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

userData

java.lang.String userData

Changes the instance's user data to the specified base64-encoded value. For command line tools, base64 encoding is performed for you.

value

java.lang.String value

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.

Class com.amazonaws.services.ec2.model.ModifyInstancePlacementRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

affinity

java.lang.String affinity

The new affinity setting for the instance.

Constraints:
Allowed Values: default, host

hostId

java.lang.String hostId

The ID of the Dedicated host that the instance will have affinity with.

instanceId

java.lang.String instanceId

The ID of the instance that you are modifying.

tenancy

java.lang.String tenancy

The tenancy of the instance that you are modifying.

Constraints:
Allowed Values: dedicated, host

Class com.amazonaws.services.ec2.model.ModifyInstancePlacementResult extends java.lang.Object implements Serializable

Serialized Fields

returnValue

java.lang.Boolean returnValue

Is true if the request succeeds, and an error otherwise.

Class com.amazonaws.services.ec2.model.ModifyNetworkInterfaceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attachment

NetworkInterfaceAttachmentChanges attachment

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

description

java.lang.String description

A description for the network interface.

groups

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> groups

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

networkInterfaceId

java.lang.String networkInterfaceId

The ID of the network interface.

sourceDestCheck

java.lang.Boolean sourceDestCheck

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

Class com.amazonaws.services.ec2.model.ModifyReservedInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

reservedInstancesIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> reservedInstancesIds

The IDs of the Reserved Instances to modify.

targetConfigurations

com.amazonaws.internal.ListWithAutoConstructFlag<ReservedInstancesConfiguration> targetConfigurations

The configuration settings for the Reserved Instances to modify.

Class com.amazonaws.services.ec2.model.ModifyReservedInstancesResult extends java.lang.Object implements Serializable

Serialized Fields

reservedInstancesModificationId

java.lang.String reservedInstancesModificationId

The ID for the modification.

Class com.amazonaws.services.ec2.model.ModifySnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

java.lang.String attribute

The snapshot attribute to modify.

Only volume creation permissions may be modified at the customer level.

Constraints:
Allowed Values: productCodes, createVolumePermission

createVolumePermission

CreateVolumePermissionModifications createVolumePermission

A JSON representation of the snapshot attribute modification.

groupNames

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> groupNames

The group to modify for the snapshot.

operationType

java.lang.String operationType

The type of operation to perform to the attribute.

Constraints:
Allowed Values: add, remove

snapshotId

java.lang.String snapshotId

The ID of the snapshot.

userIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> userIds

The account ID to modify for the snapshot.

Class com.amazonaws.services.ec2.model.ModifySpotFleetRequestRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

excessCapacityTerminationPolicy

java.lang.String excessCapacityTerminationPolicy

Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.

Constraints:
Allowed Values: noTermination, default

spotFleetRequestId

java.lang.String spotFleetRequestId

The ID of the Spot fleet request.

targetCapacity

java.lang.Integer targetCapacity

The size of the fleet.

Class com.amazonaws.services.ec2.model.ModifySpotFleetRequestResult extends java.lang.Object implements Serializable

Serialized Fields

returnValue

java.lang.Boolean returnValue

Is true if the request succeeds, and an error otherwise.

Class com.amazonaws.services.ec2.model.ModifySubnetAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

mapPublicIpOnLaunch

java.lang.Boolean mapPublicIpOnLaunch

Specify true to indicate that instances launched into the specified subnet should be assigned public IP address.

subnetId

java.lang.String subnetId

The ID of the subnet.

Class com.amazonaws.services.ec2.model.ModifyVolumeAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoEnableIO

java.lang.Boolean autoEnableIO

Indicates whether the volume should be auto-enabled for I/O operations.

volumeId

java.lang.String volumeId

The ID of the volume.

Class com.amazonaws.services.ec2.model.ModifyVpcAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

enableDnsHostnames

java.lang.Boolean enableDnsHostnames

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.

enableDnsSupport

java.lang.Boolean enableDnsSupport

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.ModifyVpcEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

addRouteTableIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> addRouteTableIds

One or more route tables IDs to associate with the endpoint.

policyDocument

java.lang.String policyDocument

A policy document to attach to the endpoint. The policy must be in valid JSON format.

removeRouteTableIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> removeRouteTableIds

One or more route table IDs to disassociate from the endpoint.

resetPolicy

java.lang.Boolean resetPolicy

Specify true to reset the policy document to the default policy. The default policy allows access to the service.

vpcEndpointId

java.lang.String vpcEndpointId

The ID of the endpoint.

Class com.amazonaws.services.ec2.model.ModifyVpcEndpointResult extends java.lang.Object implements Serializable

Serialized Fields

returnValue

java.lang.Boolean returnValue

Returns true if the request succeeds; otherwise, it returns an error.

Class com.amazonaws.services.ec2.model.ModifyVpcPeeringConnectionOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accepterPeeringConnectionOptions

PeeringConnectionOptionsRequest accepterPeeringConnectionOptions

The VPC peering connection options for the accepter VPC.

requesterPeeringConnectionOptions

PeeringConnectionOptionsRequest requesterPeeringConnectionOptions

The VPC peering connection options for the requester VPC.

vpcPeeringConnectionId

java.lang.String vpcPeeringConnectionId

The ID of the VPC peering connection.

Class com.amazonaws.services.ec2.model.ModifyVpcPeeringConnectionOptionsResult extends java.lang.Object implements Serializable

Serialized Fields

accepterPeeringConnectionOptions

PeeringConnectionOptions accepterPeeringConnectionOptions

Information about the VPC peering connection options for the accepter VPC.

requesterPeeringConnectionOptions

PeeringConnectionOptions requesterPeeringConnectionOptions

Information about the VPC peering connection options for the requester VPC.

Class com.amazonaws.services.ec2.model.Monitoring extends java.lang.Object implements Serializable

Serialized Fields

state

java.lang.String state

Indicates whether monitoring is enabled for the instance.

Constraints:
Allowed Values: disabled, disabling, enabled, pending

Class com.amazonaws.services.ec2.model.MonitorInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> instanceIds

One or more instance IDs.

Class com.amazonaws.services.ec2.model.MonitorInstancesResult extends java.lang.Object implements Serializable

Serialized Fields

instanceMonitorings

com.amazonaws.internal.ListWithAutoConstructFlag<InstanceMonitoring> instanceMonitorings

Monitoring information for one or more instances.

Class com.amazonaws.services.ec2.model.MoveAddressToVpcRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

publicIp

java.lang.String publicIp

The Elastic IP address.

Class com.amazonaws.services.ec2.model.MoveAddressToVpcResult extends java.lang.Object implements Serializable

Serialized Fields

allocationId

java.lang.String allocationId

The allocation ID for the Elastic IP address.

status

java.lang.String status

The status of the move of the IP address.

Constraints:
Allowed Values: MoveInProgress, InVpc, InClassic

Class com.amazonaws.services.ec2.model.MovingAddressStatus extends java.lang.Object implements Serializable

Serialized Fields

moveStatus

java.lang.String moveStatus

The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.

Constraints:
Allowed Values: movingToVpc, restoringToClassic

publicIp

java.lang.String publicIp

The Elastic IP address.

Class com.amazonaws.services.ec2.model.NatGateway extends java.lang.Object implements Serializable

Serialized Fields

createTime

java.util.Date createTime

The date and time the NAT gateway was created.

deleteTime

java.util.Date deleteTime

The date and time the NAT gateway was deleted, if applicable.

failureCode

java.lang.String failureCode

If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)

failureMessage

java.lang.String failureMessage

If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

• For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"

• For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"

• For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"

• For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"

• For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."

• For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."

natGatewayAddresses

com.amazonaws.internal.ListWithAutoConstructFlag<NatGatewayAddress> natGatewayAddresses

Information about the IP addresses and network interface associated with the NAT gateway.

natGatewayId

java.lang.String natGatewayId

The ID of the NAT gateway.

provisionedBandwidth

ProvisionedBandwidth provisionedBandwidth

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

state

java.lang.String state

The state of the NAT gateway.

• pending: The NAT gateway is being created and is not ready to process traffic.

• failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.

• available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.

• deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.

• deleted: The NAT gateway has been terminated and is no longer processing traffic.

Constraints:
Allowed Values: pending, failed, available, deleting, deleted

subnetId

java.lang.String subnetId

The ID of the subnet in which the NAT gateway is located.

vpcId

java.lang.String vpcId

The ID of the VPC in which the NAT gateway is located.

Class com.amazonaws.services.ec2.model.NatGatewayAddress extends java.lang.Object implements Serializable

Serialized Fields

allocationId

java.lang.String allocationId

The allocation ID of the Elastic IP address that's associated with the NAT gateway.

networkInterfaceId

java.lang.String networkInterfaceId

The ID of the network interface associated with the NAT gateway.

privateIp

java.lang.String privateIp

The private IP address associated with the Elastic IP address.

publicIp

java.lang.String publicIp

The Elastic IP address associated with the NAT gateway.

Class com.amazonaws.services.ec2.model.NetworkAcl extends java.lang.Object implements Serializable

Serialized Fields

associations

com.amazonaws.internal.ListWithAutoConstructFlag<NetworkAclAssociation> associations

Any associations between the network ACL and one or more subnets

entries

com.amazonaws.internal.ListWithAutoConstructFlag<NetworkAclEntry> entries

One or more entries (rules) in the network ACL.

isDefault

java.lang.Boolean isDefault

Indicates whether this is the default network ACL for the VPC.

networkAclId

java.lang.String networkAclId

The ID of the network ACL.

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the network ACL.

vpcId

java.lang.String vpcId

The ID of the VPC for the network ACL.

Class com.amazonaws.services.ec2.model.NetworkAclAssociation extends java.lang.Object implements Serializable

Serialized Fields

networkAclAssociationId

java.lang.String networkAclAssociationId

The ID of the association between a network ACL and a subnet.

networkAclId

java.lang.String networkAclId

The ID of the network ACL.

subnetId

java.lang.String subnetId

The ID of the subnet.

Class com.amazonaws.services.ec2.model.NetworkAclEntry extends java.lang.Object implements Serializable

Serialized Fields

cidrBlock

java.lang.String cidrBlock

The network range to allow or deny, in CIDR notation.

egress

java.lang.Boolean egress

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

icmpTypeCode

IcmpTypeCode icmpTypeCode

ICMP protocol: The ICMP type and code.

portRange

PortRange portRange

TCP or UDP protocols: The range of ports the rule applies to.

protocol

java.lang.String protocol

The protocol. A value of -1 means all protocols.

ruleAction

java.lang.String ruleAction

Indicates whether to allow or deny the traffic that matches the rule.

Constraints:
Allowed Values: allow, deny

ruleNumber

java.lang.Integer ruleNumber

The rule number for the entry. ACL entries are processed in ascending order by rule number.

Class com.amazonaws.services.ec2.model.NetworkInterface extends java.lang.Object implements Serializable

Serialized Fields

association

NetworkInterfaceAssociation association

The association information for an Elastic IP associated with the network interface.

attachment

NetworkInterfaceAttachment attachment

The network interface attachment.

availabilityZone

java.lang.String availabilityZone

The Availability Zone.

description

java.lang.String description

A description.

groups

com.amazonaws.internal.ListWithAutoConstructFlag<GroupIdentifier> groups

Any security groups for the network interface.

interfaceType

java.lang.String interfaceType

The type of interface.

Constraints:
Allowed Values: interface, natGateway

macAddress

java.lang.String macAddress

The MAC address.

networkInterfaceId

java.lang.String networkInterfaceId

The ID of the network interface.

ownerId

java.lang.String ownerId

The AWS account ID of the owner of the network interface.

privateDnsName

java.lang.String privateDnsName

The private DNS name.

privateIpAddress

java.lang.String privateIpAddress

The IP address of the network interface within the subnet.

privateIpAddresses

com.amazonaws.internal.ListWithAutoConstructFlag<NetworkInterfacePrivateIpAddress> privateIpAddresses

The private IP addresses associated with the network interface.

requesterId

java.lang.String requesterId

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

requesterManaged

java.lang.Boolean requesterManaged

Indicates whether the network interface is being managed by AWS.

sourceDestCheck

java.lang.Boolean sourceDestCheck

Indicates whether traffic to or from the instance is validated.

status

java.lang.String status

The status of the network interface.

Constraints:
Allowed Values: available, attaching, in-use, detaching

subnetId

java.lang.String subnetId

The ID of the subnet.

tagSet

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tagSet

Any tags assigned to the network interface.

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.NetworkInterfaceAssociation extends java.lang.Object implements Serializable

Serialized Fields

allocationId

java.lang.String allocationId

The allocation ID.

associationId

java.lang.String associationId

The association ID.

ipOwnerId

java.lang.String ipOwnerId

The ID of the Elastic IP address owner.

publicDnsName

java.lang.String publicDnsName

The public DNS name.

publicIp

java.lang.String publicIp

The address of the Elastic IP address bound to the network interface.

Class com.amazonaws.services.ec2.model.NetworkInterfaceAttachment extends java.lang.Object implements Serializable

Serialized Fields

attachmentId

java.lang.String attachmentId

The ID of the network interface attachment.

attachTime

java.util.Date attachTime

The timestamp indicating when the attachment initiated.

deleteOnTermination

java.lang.Boolean deleteOnTermination

Indicates whether the network interface is deleted when the instance is terminated.

deviceIndex

java.lang.Integer deviceIndex

The device index of the network interface attachment on the instance.

instanceId

java.lang.String instanceId

The ID of the instance.

instanceOwnerId

java.lang.String instanceOwnerId

The AWS account ID of the owner of the instance.

status

java.lang.String status

The attachment state.

Constraints:
Allowed Values: attaching, attached, detaching, detached

Class com.amazonaws.services.ec2.model.NetworkInterfaceAttachmentChanges extends java.lang.Object implements Serializable

Serialized Fields

attachmentId

java.lang.String attachmentId

The ID of the network interface attachment.

deleteOnTermination

java.lang.Boolean deleteOnTermination

Indicates whether the network interface is deleted when the instance is terminated.

Class com.amazonaws.services.ec2.model.NetworkInterfacePrivateIpAddress extends java.lang.Object implements Serializable

Serialized Fields

association

NetworkInterfaceAssociation association

The association information for an Elastic IP address associated with the network interface.

primary

java.lang.Boolean primary

Indicates whether this IP address is the primary private IP address of the network interface.

privateDnsName

java.lang.String privateDnsName

The private DNS name.

privateIpAddress

java.lang.String privateIpAddress

The private IP address.

Class com.amazonaws.services.ec2.model.PeeringConnectionOptions extends java.lang.Object implements Serializable

Serialized Fields

allowEgressFromLocalClassicLinkToRemoteVpc

java.lang.Boolean allowEgressFromLocalClassicLinkToRemoteVpc

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

allowEgressFromLocalVpcToRemoteClassicLink

java.lang.Boolean allowEgressFromLocalVpcToRemoteClassicLink

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

Class com.amazonaws.services.ec2.model.PeeringConnectionOptionsRequest extends java.lang.Object implements Serializable

Serialized Fields

allowEgressFromLocalClassicLinkToRemoteVpc

java.lang.Boolean allowEgressFromLocalClassicLinkToRemoteVpc

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

allowEgressFromLocalVpcToRemoteClassicLink

java.lang.Boolean allowEgressFromLocalVpcToRemoteClassicLink

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

Class com.amazonaws.services.ec2.model.Placement extends java.lang.Object implements Serializable

Serialized Fields

affinity

java.lang.String affinity

The affinity setting for the instance on the Dedicated host. This parameter is not supported for the ImportInstance command.

availabilityZone

java.lang.String availabilityZone

The Availability Zone of the instance.

groupName

java.lang.String groupName

The name of the placement group the instance is in (for cluster compute instances).

hostId

java.lang.String hostId

The ID of the Dedicted host on which the instance resides. This parameter is not support for the ImportInstance command.

tenancy

java.lang.String tenancy

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

Constraints:
Allowed Values: default, dedicated, host

Class com.amazonaws.services.ec2.model.PlacementGroup extends java.lang.Object implements Serializable

Serialized Fields

groupName

java.lang.String groupName

The name of the placement group.

state

java.lang.String state

The state of the placement group.

Constraints:
Allowed Values: pending, available, deleting, deleted

strategy

java.lang.String strategy

The placement strategy.

Constraints:
Allowed Values: cluster

Class com.amazonaws.services.ec2.model.PortRange extends java.lang.Object implements Serializable

Serialized Fields

from

java.lang.Integer from

The first port in the range.

to

java.lang.Integer to

The last port in the range.

Class com.amazonaws.services.ec2.model.PrefixList extends java.lang.Object implements Serializable

Serialized Fields

cidrs

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> cidrs

The IP address range of the AWS service.

prefixListId

java.lang.String prefixListId

The ID of the prefix.

prefixListName

java.lang.String prefixListName

The name of the prefix.

Class com.amazonaws.services.ec2.model.PrefixListId extends java.lang.Object implements Serializable

Serialized Fields

prefixListId

java.lang.String prefixListId

The ID of the prefix.

Class com.amazonaws.services.ec2.model.PriceSchedule extends java.lang.Object implements Serializable

Serialized Fields

active

java.lang.Boolean active

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

currencyCode

java.lang.String currencyCode

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

Constraints:
Allowed Values: USD

price

java.lang.Double price

The fixed price for the term.

term

java.lang.Long term

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

Class com.amazonaws.services.ec2.model.PriceScheduleSpecification extends java.lang.Object implements Serializable

Serialized Fields

currencyCode

java.lang.String currencyCode

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

Constraints:
Allowed Values: USD

price

java.lang.Double price

The fixed price for the term.

term

java.lang.Long term

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

Class com.amazonaws.services.ec2.model.PricingDetail extends java.lang.Object implements Serializable

Serialized Fields

count

java.lang.Integer count

The number of reservations available for the price.

price

java.lang.Double price

The price per instance.

Class com.amazonaws.services.ec2.model.PrivateIpAddressSpecification extends java.lang.Object implements Serializable

Serialized Fields

primary

java.lang.Boolean primary

Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.

privateIpAddress

java.lang.String privateIpAddress

The private IP addresses.

Class com.amazonaws.services.ec2.model.ProductCode extends java.lang.Object implements Serializable

Serialized Fields

productCodeId

java.lang.String productCodeId

The product code.

productCodeType

java.lang.String productCodeType

The type of product code.

Constraints:
Allowed Values: devpay, marketplace

Class com.amazonaws.services.ec2.model.PropagatingVgw extends java.lang.Object implements Serializable

Serialized Fields

gatewayId

java.lang.String gatewayId

The ID of the virtual private gateway (VGW).

Class com.amazonaws.services.ec2.model.ProvisionedBandwidth extends java.lang.Object implements Serializable

Serialized Fields

provisioned

java.lang.String provisioned

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

provisionTime

java.util.Date provisionTime

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

requested

java.lang.String requested

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

requestTime

java.util.Date requestTime

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

status

java.lang.String status

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

Class com.amazonaws.services.ec2.model.PurchaseRequest extends java.lang.Object implements Serializable

Serialized Fields

instanceCount

java.lang.Integer instanceCount

The number of instances.

purchaseToken

java.lang.String purchaseToken

The purchase token.

Class com.amazonaws.services.ec2.model.PurchaseReservedInstancesOfferingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceCount

java.lang.Integer instanceCount

The number of Reserved Instances to purchase.

limitPrice

ReservedInstanceLimitPrice limitPrice

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

reservedInstancesOfferingId

java.lang.String reservedInstancesOfferingId

The ID of the Reserved Instance offering to purchase.

Class com.amazonaws.services.ec2.model.PurchaseReservedInstancesOfferingResult extends java.lang.Object implements Serializable

Serialized Fields

reservedInstancesId

java.lang.String reservedInstancesId

The IDs of the purchased Reserved Instances.

Class com.amazonaws.services.ec2.model.PurchaseScheduledInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

purchaseRequests

com.amazonaws.internal.ListWithAutoConstructFlag<PurchaseRequest> purchaseRequests

One or more purchase requests.

Constraints:
Length: 1 -

Class com.amazonaws.services.ec2.model.PurchaseScheduledInstancesResult extends java.lang.Object implements Serializable

Serialized Fields

scheduledInstanceSet

com.amazonaws.internal.ListWithAutoConstructFlag<ScheduledInstance> scheduledInstanceSet

Information about the Scheduled Instances.

Class com.amazonaws.services.ec2.model.RebootInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> instanceIds

One or more instance IDs.

Class com.amazonaws.services.ec2.model.RecurringCharge extends java.lang.Object implements Serializable

Serialized Fields

amount

java.lang.Double amount

The amount of the recurring charge.

frequency

java.lang.String frequency

The frequency of the recurring charge.

Constraints:
Allowed Values: Hourly

Class com.amazonaws.services.ec2.model.Region extends java.lang.Object implements Serializable

Serialized Fields

endpoint

java.lang.String endpoint

The region service endpoint.

regionName

java.lang.String regionName

The name of the region.

Class com.amazonaws.services.ec2.model.RegisterImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

architecture

java.lang.String architecture

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

Constraints:
Allowed Values: i386, x86_64

blockDeviceMappings

com.amazonaws.internal.ListWithAutoConstructFlag<BlockDeviceMapping> blockDeviceMappings

One or more block device mapping entries.

description

java.lang.String description

A description for your AMI.

imageLocation

java.lang.String imageLocation

The full path to your AMI manifest in Amazon S3 storage.

kernelId

java.lang.String kernelId

The ID of the kernel.

name

java.lang.String name

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

ramdiskId

java.lang.String ramdiskId

The ID of the RAM disk.

rootDeviceName

java.lang.String rootDeviceName

The name of the root device (for example, /dev/sda1, or /dev/xvda).

sriovNetSupport

java.lang.String sriovNetSupport

Set to simple to enable enhanced networking for the AMI and any instances that you launch from the AMI.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

virtualizationType

java.lang.String virtualizationType

The type of virtualization.

Default: paravirtual

Class com.amazonaws.services.ec2.model.RegisterImageResult extends java.lang.Object implements Serializable

Serialized Fields

imageId

java.lang.String imageId

The ID of the newly registered AMI.

Class com.amazonaws.services.ec2.model.RejectVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcPeeringConnectionId

java.lang.String vpcPeeringConnectionId

The ID of the VPC peering connection.

Class com.amazonaws.services.ec2.model.RejectVpcPeeringConnectionResult extends java.lang.Object implements Serializable

Serialized Fields

returnValue

java.lang.Boolean returnValue

Returns true if the request succeeds; otherwise, it returns an error.

Class com.amazonaws.services.ec2.model.ReleaseAddressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

allocationId

java.lang.String allocationId

[EC2-VPC] The allocation ID. Required for EC2-VPC.

publicIp

java.lang.String publicIp

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

Class com.amazonaws.services.ec2.model.ReleaseHostsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

hostIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> hostIds

The IDs of the Dedicated hosts you want to release.

Class com.amazonaws.services.ec2.model.ReleaseHostsResult extends java.lang.Object implements Serializable

Serialized Fields

successful

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> successful

The IDs of the Dedicated hosts that were successfully released.

unsuccessful

com.amazonaws.internal.ListWithAutoConstructFlag<UnsuccessfulItem> unsuccessful

The IDs of the Dedicated hosts that could not be released, including an error message.

Class com.amazonaws.services.ec2.model.ReplaceNetworkAclAssociationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

associationId

java.lang.String associationId

The ID of the current association between the original network ACL and the subnet.

networkAclId

java.lang.String networkAclId

The ID of the new network ACL to associate with the subnet.

Class com.amazonaws.services.ec2.model.ReplaceNetworkAclAssociationResult extends java.lang.Object implements Serializable

Serialized Fields

newAssociationId

java.lang.String newAssociationId

The ID of the new association.

Class com.amazonaws.services.ec2.model.ReplaceNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cidrBlock

java.lang.String cidrBlock

The network range to allow or deny, in CIDR notation.

egress

java.lang.Boolean egress

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

icmpTypeCode

IcmpTypeCode icmpTypeCode

ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.

networkAclId

java.lang.String networkAclId

The ID of the ACL.

portRange

PortRange portRange

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.

protocol

java.lang.String protocol

The IP protocol. You can specify all or -1 to mean all protocols.

ruleAction

java.lang.String ruleAction

Indicates whether to allow or deny the traffic that matches the rule.

Constraints:
Allowed Values: allow, deny

ruleNumber

java.lang.Integer ruleNumber

The rule number of the entry to replace.

Class com.amazonaws.services.ec2.model.ReplaceRouteRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationCidrBlock

java.lang.String destinationCidrBlock

The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.

gatewayId

java.lang.String gatewayId

The ID of an Internet gateway or virtual private gateway.

instanceId

java.lang.String instanceId

The ID of a NAT instance in your VPC.

natGatewayId

java.lang.String natGatewayId

The ID of a NAT gateway.

networkInterfaceId

java.lang.String networkInterfaceId

The ID of a network interface.

routeTableId

java.lang.String routeTableId

The ID of the route table.

vpcPeeringConnectionId

java.lang.String vpcPeeringConnectionId

The ID of a VPC peering connection.

Class com.amazonaws.services.ec2.model.ReplaceRouteTableAssociationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

associationId

java.lang.String associationId

The association ID.

routeTableId

java.lang.String routeTableId

The ID of the new route table to associate with the subnet.

Class com.amazonaws.services.ec2.model.ReplaceRouteTableAssociationResult extends java.lang.Object implements Serializable

Serialized Fields

newAssociationId

java.lang.String newAssociationId

The ID of the new association.

Class com.amazonaws.services.ec2.model.ReportInstanceStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

Descriptive text about the health state of your instance.

endTime

java.util.Date endTime

The time at which the reported instance health state ended.

instances

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> instances

One or more instances.

reasonCodes

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> reasonCodes

One or more reason codes that describes the health state of your instance.

• instance-stuck-in-state: My instance is stuck in a state.

• unresponsive: My instance is unresponsive.

• not-accepting-credentials: My instance is not accepting my credentials.

• password-not-available: A password is not available for my instance.

• performance-network: My instance is experiencing performance problems which I believe are network related.

• performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.

• performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.

• performance-other: My instance is experiencing performance problems.

• other: [explain using the description parameter]

startTime

java.util.Date startTime

The time at which the reported instance health state began.

status

java.lang.String status

The status of all instances listed.

Constraints:
Allowed Values: ok, impaired

Class com.amazonaws.services.ec2.model.RequestSpotFleetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

spotFleetRequestConfig

SpotFleetRequestConfigData spotFleetRequestConfig

The configuration for the Spot fleet request.

Class com.amazonaws.services.ec2.model.RequestSpotFleetResult extends java.lang.Object implements Serializable

Serialized Fields

spotFleetRequestId

java.lang.String spotFleetRequestId

The ID of the Spot fleet request.

Class com.amazonaws.services.ec2.model.RequestSpotInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

availabilityZoneGroup

java.lang.String availabilityZoneGroup

The user-specified name for a logical grouping of bids.

When you specify an Availability Zone group in a Spot Instance request, all Spot instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

blockDurationMinutes

java.lang.Integer blockDurationMinutes

The required duration for the Spot instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

The duration period starts as soon as your Spot instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.

Note that you can't specify an Availability Zone group or a launch group if you specify a duration.

clientToken

java.lang.String clientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

instanceCount

java.lang.Integer instanceCount

The maximum number of Spot instances to launch.

Default: 1

launchGroup

java.lang.String launchGroup

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

Default: Instances are launched and terminated individually

launchSpecification

LaunchSpecification launchSpecification

The launch specification.

spotPrice

java.lang.String spotPrice

The maximum hourly price (bid) for any Spot instance launched to fulfill the request.

type

java.lang.String type

The Spot instance request type.

Default: one-time

Constraints:
Allowed Values: one-time, persistent

validFrom

java.util.Date validFrom

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

Default: The request is effective indefinitely.

validUntil

java.util.Date validUntil

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

Default: The request is effective indefinitely.

Class com.amazonaws.services.ec2.model.RequestSpotInstancesResult extends java.lang.Object implements Serializable

Serialized Fields

spotInstanceRequests

com.amazonaws.internal.ListWithAutoConstructFlag<SpotInstanceRequest> spotInstanceRequests

One or more Spot instance requests.

Class com.amazonaws.services.ec2.model.Reservation extends java.lang.Object implements Serializable

Serialized Fields

groupNames

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> groupNames

[EC2-Classic only] One or more security groups.

groups

com.amazonaws.internal.ListWithAutoConstructFlag<GroupIdentifier> groups

[EC2-Classic only] One or more security groups.

instances

com.amazonaws.internal.ListWithAutoConstructFlag<Instance> instances

One or more instances.

ownerId

java.lang.String ownerId

The ID of the AWS account that owns the reservation.

requesterId

java.lang.String requesterId

The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

reservationId

java.lang.String reservationId

The ID of the reservation.

Class com.amazonaws.services.ec2.model.ReservedInstanceLimitPrice extends java.lang.Object implements Serializable

Serialized Fields

amount

java.lang.Double amount

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

currencyCode

java.lang.String currencyCode

The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

Constraints:
Allowed Values: USD

Class com.amazonaws.services.ec2.model.ReservedInstances extends java.lang.Object implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone in which the Reserved Instance can be used.

currencyCode

java.lang.String currencyCode

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

Constraints:
Allowed Values: USD

duration

java.lang.Long duration

The duration of the Reserved Instance, in seconds.

end

java.util.Date end

The time when the Reserved Instance expires.

fixedPrice

java.lang.Float fixedPrice

The purchase price of the Reserved Instance.

instanceCount

java.lang.Integer instanceCount

The number of reservations purchased.

instanceTenancy

java.lang.String instanceTenancy

The tenancy of the instance.

Constraints:
Allowed Values: default, dedicated, host

instanceType

java.lang.String instanceType

The instance type on which the Reserved Instance can be used.

Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge

offeringType

java.lang.String offeringType

The Reserved Instance offering type.

Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront

productDescription

java.lang.String productDescription

The Reserved Instance product platform description.

Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)

recurringCharges

com.amazonaws.internal.ListWithAutoConstructFlag<RecurringCharge> recurringCharges

The recurring charge tag assigned to the resource.

reservedInstancesId

java.lang.String reservedInstancesId

The ID of the Reserved Instance.

start

java.util.Date start

The date and time the Reserved Instance started.

state

java.lang.String state

The state of the Reserved Instance purchase.

Constraints:
Allowed Values: payment-pending, active, payment-failed, retired

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the resource.

usagePrice

java.lang.Float usagePrice

The usage price of the Reserved Instance, per hour.

Class com.amazonaws.services.ec2.model.ReservedInstancesConfiguration extends java.lang.Object implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone for the modified Reserved Instances.

instanceCount

java.lang.Integer instanceCount

The number of modified Reserved Instances.

instanceType

java.lang.String instanceType

The instance type for the modified Reserved Instances.

Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge

platform

java.lang.String platform

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

Class com.amazonaws.services.ec2.model.ReservedInstancesId extends java.lang.Object implements Serializable

Serialized Fields

reservedInstancesId

java.lang.String reservedInstancesId

The ID of the Reserved Instance.

Class com.amazonaws.services.ec2.model.ReservedInstancesListing extends java.lang.Object implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

createDate

java.util.Date createDate

The time the listing was created.

instanceCounts

com.amazonaws.internal.ListWithAutoConstructFlag<InstanceCount> instanceCounts

The number of instances in this state.

priceSchedules

com.amazonaws.internal.ListWithAutoConstructFlag<PriceSchedule> priceSchedules

The price of the Reserved Instance listing.

reservedInstancesId

java.lang.String reservedInstancesId

The ID of the Reserved Instance.

reservedInstancesListingId

java.lang.String reservedInstancesListingId

The ID of the Reserved Instance listing.

status

java.lang.String status

The status of the Reserved Instance listing.

Constraints:
Allowed Values: active, pending, cancelled, closed

statusMessage

java.lang.String statusMessage

The reason for the current status of the Reserved Instance listing. The response can be blank.

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the resource.

updateDate

java.util.Date updateDate

The last modified timestamp of the listing.

Class com.amazonaws.services.ec2.model.ReservedInstancesModification extends java.lang.Object implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

createDate

java.util.Date createDate

The time when the modification request was created.

effectiveDate

java.util.Date effectiveDate

The time for the modification to become effective.

modificationResults

com.amazonaws.internal.ListWithAutoConstructFlag<ReservedInstancesModificationResult> modificationResults

Contains target configurations along with their corresponding new Reserved Instance IDs.

reservedInstancesIds

com.amazonaws.internal.ListWithAutoConstructFlag<ReservedInstancesId> reservedInstancesIds

The IDs of one or more Reserved Instances.

reservedInstancesModificationId

java.lang.String reservedInstancesModificationId

A unique ID for the Reserved Instance modification.

status

java.lang.String status

The status of the Reserved Instances modification request.

statusMessage

java.lang.String statusMessage

The reason for the status.

updateDate

java.util.Date updateDate

The time when the modification request was last updated.

Class com.amazonaws.services.ec2.model.ReservedInstancesModificationResult extends java.lang.Object implements Serializable

Serialized Fields

reservedInstancesId

java.lang.String reservedInstancesId

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

targetConfiguration

ReservedInstancesConfiguration targetConfiguration

The target Reserved Instances configurations supplied as part of the modification request.

Class com.amazonaws.services.ec2.model.ReservedInstancesOffering extends java.lang.Object implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone in which the Reserved Instance can be used.

currencyCode

java.lang.String currencyCode

The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

Constraints:
Allowed Values: USD

duration

java.lang.Long duration

The duration of the Reserved Instance, in seconds.

fixedPrice

java.lang.Float fixedPrice

The purchase price of the Reserved Instance.

instanceTenancy

java.lang.String instanceTenancy

The tenancy of the instance.

Constraints:
Allowed Values: default, dedicated, host

instanceType

java.lang.String instanceType

The instance type on which the Reserved Instance can be used.

Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge

marketplace

java.lang.Boolean marketplace

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.

offeringType

java.lang.String offeringType

The Reserved Instance offering type.

Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront

pricingDetails

com.amazonaws.internal.ListWithAutoConstructFlag<PricingDetail> pricingDetails

The pricing details of the Reserved Instance offering.

productDescription

java.lang.String productDescription

The Reserved Instance product platform description.

Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)

recurringCharges

com.amazonaws.internal.ListWithAutoConstructFlag<RecurringCharge> recurringCharges

The recurring charge tag assigned to the resource.

reservedInstancesOfferingId

java.lang.String reservedInstancesOfferingId

The ID of the Reserved Instance offering.

usagePrice

java.lang.Float usagePrice

The usage price of the Reserved Instance, per hour.

Class com.amazonaws.services.ec2.model.ResetImageAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

java.lang.String attribute

The attribute to reset (currently you can only reset the launch permission attribute).

Constraints:
Allowed Values: launchPermission

imageId

java.lang.String imageId

The ID of the AMI.

Class com.amazonaws.services.ec2.model.ResetInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

java.lang.String attribute

The attribute to reset.

You can only reset the following attributes: kernel | ramdisk | sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute.

Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport

instanceId

java.lang.String instanceId

The ID of the instance.

Class com.amazonaws.services.ec2.model.ResetNetworkInterfaceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkInterfaceId

java.lang.String networkInterfaceId

The ID of the network interface.

sourceDestCheck

java.lang.String sourceDestCheck

The source/destination checking attribute. Resets the value to true.

Class com.amazonaws.services.ec2.model.ResetSnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

java.lang.String attribute

The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.

Constraints:
Allowed Values: productCodes, createVolumePermission

snapshotId

java.lang.String snapshotId

The ID of the snapshot.

Class com.amazonaws.services.ec2.model.RestoreAddressToClassicRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

publicIp

java.lang.String publicIp

The Elastic IP address.

Class com.amazonaws.services.ec2.model.RestoreAddressToClassicResult extends java.lang.Object implements Serializable

Serialized Fields

publicIp

java.lang.String publicIp

The Elastic IP address.

status

java.lang.String status

The move status for the IP address.

Constraints:
Allowed Values: MoveInProgress, InVpc, InClassic

Class com.amazonaws.services.ec2.model.RevokeSecurityGroupEgressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cidrIp

java.lang.String cidrIp

The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.

fromPort

java.lang.Integer fromPort

The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

groupId

java.lang.String groupId

The ID of the security group.

ipPermissions

com.amazonaws.internal.ListWithAutoConstructFlag<IpPermission> ipPermissions

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

ipProtocol

java.lang.String ipProtocol

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

sourceSecurityGroupName

java.lang.String sourceSecurityGroupName

The name of a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

sourceSecurityGroupOwnerId

java.lang.String sourceSecurityGroupOwnerId

The AWS account number for a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

toPort

java.lang.Integer toPort

The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

Class com.amazonaws.services.ec2.model.RevokeSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cidrIp

java.lang.String cidrIp

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

fromPort

java.lang.Integer fromPort

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

groupId

java.lang.String groupId

The ID of the security group. Required for a security group in a nondefault VPC.

groupName

java.lang.String groupName

[EC2-Classic, default VPC] The name of the security group.

ipPermissions

com.amazonaws.internal.ListWithAutoConstructFlag<IpPermission> ipPermissions

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

ipProtocol

java.lang.String ipProtocol

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

sourceSecurityGroupName

java.lang.String sourceSecurityGroupName

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

sourceSecurityGroupOwnerId

java.lang.String sourceSecurityGroupOwnerId

[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

toPort

java.lang.Integer toPort

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

Class com.amazonaws.services.ec2.model.Route extends java.lang.Object implements Serializable

Serialized Fields

destinationCidrBlock

java.lang.String destinationCidrBlock

The CIDR block used for the destination match.

destinationPrefixListId

java.lang.String destinationPrefixListId

The prefix of the AWS service.

gatewayId

java.lang.String gatewayId

The ID of a gateway attached to your VPC.

instanceId

java.lang.String instanceId

The ID of a NAT instance in your VPC.

instanceOwnerId

java.lang.String instanceOwnerId

The AWS account ID of the owner of the instance.

natGatewayId

java.lang.String natGatewayId

The ID of a NAT gateway.

networkInterfaceId

java.lang.String networkInterfaceId

The ID of the network interface.

origin

java.lang.String origin

Describes how the route was created.

• CreateRouteTable - The route was automatically created when the route table was created.

• CreateRoute - The route was manually added to the route table.

• EnableVgwRoutePropagation - The route was propagated by route propagation.

Constraints:
Allowed Values: CreateRouteTable, CreateRoute, EnableVgwRoutePropagation

state

java.lang.String state

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

Constraints:
Allowed Values: active, blackhole

vpcPeeringConnectionId

java.lang.String vpcPeeringConnectionId

The ID of the VPC peering connection.

Class com.amazonaws.services.ec2.model.RouteTable extends java.lang.Object implements Serializable

Serialized Fields

associations

com.amazonaws.internal.ListWithAutoConstructFlag<RouteTableAssociation> associations

The associations between the route table and one or more subnets.

propagatingVgws

com.amazonaws.internal.ListWithAutoConstructFlag<PropagatingVgw> propagatingVgws

Any virtual private gateway (VGW) propagating routes.

routes

com.amazonaws.internal.ListWithAutoConstructFlag<Route> routes

The routes in the route table.

routeTableId

java.lang.String routeTableId

The ID of the route table.

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the route table.

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.RouteTableAssociation extends java.lang.Object implements Serializable

Serialized Fields

main

java.lang.Boolean main

Indicates whether this is the main route table.

routeTableAssociationId

java.lang.String routeTableAssociationId

The ID of the association between a route table and a subnet.

routeTableId

java.lang.String routeTableId

The ID of the route table.

subnetId

java.lang.String subnetId

The ID of the subnet. A subnet ID is not returned for an implicit association.

Class com.amazonaws.services.ec2.model.RunInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

additionalInfo

java.lang.String additionalInfo

Reserved.

blockDeviceMappings

com.amazonaws.internal.ListWithAutoConstructFlag<BlockDeviceMapping> blockDeviceMappings

The block device mapping.

clientToken

java.lang.String clientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

disableApiTermination

java.lang.Boolean disableApiTermination

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

ebsOptimized

java.lang.Boolean ebsOptimized

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

iamInstanceProfile

IamInstanceProfileSpecification iamInstanceProfile

The IAM instance profile.

imageId

java.lang.String imageId

The ID of the AMI, which you can get by calling DescribeImages.

instanceInitiatedShutdownBehavior

java.lang.String instanceInitiatedShutdownBehavior

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

Constraints:
Allowed Values: stop, terminate

instanceType

java.lang.String instanceType

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge

kernelId

java.lang.String kernelId

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

keyName

java.lang.String keyName

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

maxCount

java.lang.Integer maxCount

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.

minCount

java.lang.Integer minCount

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

monitoring

java.lang.Boolean monitoring

The monitoring for the instance.

networkInterfaces

com.amazonaws.internal.ListWithAutoConstructFlag<InstanceNetworkInterfaceSpecification> networkInterfaces

One or more network interfaces.

placement

Placement placement

The placement for the instance.

privateIpAddress

java.lang.String privateIpAddress

[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.

Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.

Default: We select an IP address from the IP address range of the subnet.

ramdiskId

java.lang.String ramdiskId

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

securityGroupIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> securityGroupIds

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

securityGroups

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> securityGroups

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

subnetId

java.lang.String subnetId

[EC2-VPC] The ID of the subnet to launch the instance into.

userData

java.lang.String userData

Data to configure the instance, or a script to run during instance launch. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). For API calls, the text must be base64-encoded. For command line tools, the encoding is performed for you, and you can load the text from a file.

Class com.amazonaws.services.ec2.model.RunInstancesResult extends java.lang.Object implements Serializable

Serialized Fields

reservation

Reservation reservation

Zero or more reservations.

Class com.amazonaws.services.ec2.model.RunScheduledInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

instanceCount

java.lang.Integer instanceCount

The number of instances.

Default: 1

launchSpecification

ScheduledInstancesLaunchSpecification launchSpecification

The launch specification.

scheduledInstanceId

java.lang.String scheduledInstanceId

The Scheduled Instance ID.

Class com.amazonaws.services.ec2.model.RunScheduledInstancesResult extends java.lang.Object implements Serializable

Serialized Fields

instanceIdSet

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> instanceIdSet

The IDs of the newly launched instances.

Class com.amazonaws.services.ec2.model.S3Storage extends java.lang.Object implements Serializable

Serialized Fields

aWSAccessKeyId

java.lang.String aWSAccessKeyId

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

bucket

java.lang.String bucket

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

prefix

java.lang.String prefix

The beginning of the file name of the AMI.

uploadPolicy

java.lang.String uploadPolicy

A base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf. For command line tools, base64 encoding is performed for you.

uploadPolicySignature

java.lang.String uploadPolicySignature

The signature of the Base64 encoded JSON document.

Class com.amazonaws.services.ec2.model.ScheduledInstance extends java.lang.Object implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone.

createDate

java.util.Date createDate

The date when the Scheduled Instance was purchased.

hourlyPrice

java.lang.String hourlyPrice

The hourly price for a single instance.

instanceCount

java.lang.Integer instanceCount

The number of instances.

instanceType

java.lang.String instanceType

The instance type.

networkPlatform

java.lang.String networkPlatform

The network platform (EC2-Classic or EC2-VPC).

nextSlotStartTime

java.util.Date nextSlotStartTime

The time for the next schedule to start.

platform

java.lang.String platform

The platform (Linux/UNIX or Windows).

previousSlotEndTime

java.util.Date previousSlotEndTime

The time that the previous schedule ended or will end.

recurrence

ScheduledInstanceRecurrence recurrence

The schedule recurrence.

scheduledInstanceId

java.lang.String scheduledInstanceId

The Scheduled Instance ID.

slotDurationInHours

java.lang.Integer slotDurationInHours

The number of hours in the schedule.

termEndDate

java.util.Date termEndDate

The end date for the Scheduled Instance.

termStartDate

java.util.Date termStartDate

The start date for the Scheduled Instance.

totalScheduledInstanceHours

java.lang.Integer totalScheduledInstanceHours

The total number of hours for a single instance for the entire term.

Class com.amazonaws.services.ec2.model.ScheduledInstanceAvailability extends java.lang.Object implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone.

availableInstanceCount

java.lang.Integer availableInstanceCount

The number of available instances.

firstSlotStartTime

java.util.Date firstSlotStartTime

The time period for the first schedule to start.

hourlyPrice

java.lang.String hourlyPrice

The hourly price for a single instance.

instanceType

java.lang.String instanceType

The instance type. You can specify one of the C3, C4, M4, or R3 instance types.

maxTermDurationInDays

java.lang.Integer maxTermDurationInDays

The maximum term. The only possible value is 365 days.

minTermDurationInDays

java.lang.Integer minTermDurationInDays

The minimum term. The only possible value is 365 days.

networkPlatform

java.lang.String networkPlatform

The network platform (EC2-Classic or EC2-VPC).

platform

java.lang.String platform

The platform (Linux/UNIX or Windows).

purchaseToken

java.lang.String purchaseToken

The purchase token. This token expires in two hours.

recurrence

ScheduledInstanceRecurrence recurrence

The schedule recurrence.

slotDurationInHours

java.lang.Integer slotDurationInHours

The number of hours in the schedule.

totalScheduledInstanceHours

java.lang.Integer totalScheduledInstanceHours

The total number of hours for a single instance for the entire term.

Class com.amazonaws.services.ec2.model.ScheduledInstanceRecurrence extends java.lang.Object implements Serializable

Serialized Fields

frequency

java.lang.String frequency

The frequency (Daily, Weekly, or Monthly).

interval

java.lang.Integer interval

The interval quantity. The interval unit depends on the value of frequency. For example, every 2 weeks or every 2 months.

occurrenceDaySet

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.Integer> occurrenceDaySet

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).

occurrenceRelativeToEnd

java.lang.Boolean occurrenceRelativeToEnd

Indicates whether the occurrence is relative to the end of the specified week or month.

occurrenceUnit

java.lang.String occurrenceUnit

The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).

Class com.amazonaws.services.ec2.model.ScheduledInstanceRecurrenceRequest extends java.lang.Object implements Serializable

Serialized Fields

frequency

java.lang.String frequency

The frequency (Daily, Weekly, or Monthly).

interval

java.lang.Integer interval

The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.

occurrenceDays

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.Integer> occurrenceDays

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.

occurrenceRelativeToEnd

java.lang.Boolean occurrenceRelativeToEnd

Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.

occurrenceUnit

java.lang.String occurrenceUnit

The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.

Class com.amazonaws.services.ec2.model.ScheduledInstancesBlockDeviceMapping extends java.lang.Object implements Serializable

Serialized Fields

deviceName

java.lang.String deviceName

The device name exposed to the instance (for example, /dev/sdh or xvdh).

ebs

ScheduledInstancesEbs ebs

Parameters used to set up EBS volumes automatically when the instance is launched.

noDevice

java.lang.String noDevice

Suppresses the specified device included in the block device mapping of the AMI.

virtualName

java.lang.String virtualName

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with two available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

Class com.amazonaws.services.ec2.model.ScheduledInstancesEbs extends java.lang.Object implements Serializable

Serialized Fields

deleteOnTermination

java.lang.Boolean deleteOnTermination

Indicates whether the volume is deleted on instance termination.

encrypted

java.lang.Boolean encrypted

Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.

iops

java.lang.Integer iops

The number of I/O operations per second (IOPS) that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about gp2 baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

snapshotId

java.lang.String snapshotId

The ID of the snapshot.

volumeSize

java.lang.Integer volumeSize

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

volumeType

java.lang.String volumeType

The volume type. gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, Throughput Optimized HDD for st1, Cold HDD for sc1, or standard for Magnetic.

Default: standard

Class com.amazonaws.services.ec2.model.ScheduledInstancesIamInstanceProfile extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN).

name

java.lang.String name

The name.

Class com.amazonaws.services.ec2.model.ScheduledInstancesLaunchSpecification extends java.lang.Object implements Serializable

Serialized Fields

blockDeviceMappings

com.amazonaws.internal.ListWithAutoConstructFlag<ScheduledInstancesBlockDeviceMapping> blockDeviceMappings

One or more block device mapping entries.

ebsOptimized

java.lang.Boolean ebsOptimized

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

iamInstanceProfile

ScheduledInstancesIamInstanceProfile iamInstanceProfile

The IAM instance profile.

imageId

java.lang.String imageId

The ID of the Amazon Machine Image (AMI).

instanceType

java.lang.String instanceType

The instance type.

kernelId

java.lang.String kernelId

The ID of the kernel.

keyName

java.lang.String keyName

The name of the key pair.

monitoring

ScheduledInstancesMonitoring monitoring

Enable or disable monitoring for the instances.

networkInterfaces

com.amazonaws.internal.ListWithAutoConstructFlag<ScheduledInstancesNetworkInterface> networkInterfaces

One or more network interfaces.

placement

ScheduledInstancesPlacement placement

The placement information.

ramdiskId

java.lang.String ramdiskId

The ID of the RAM disk.

securityGroupIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> securityGroupIds

The IDs of one or more security groups.

subnetId

java.lang.String subnetId

The ID of the subnet in which to launch the instances.

userData

java.lang.String userData

The base64-encoded MIME user data.

Class com.amazonaws.services.ec2.model.ScheduledInstancesMonitoring extends java.lang.Object implements Serializable

Serialized Fields

enabled

java.lang.Boolean enabled

Indicates whether monitoring is enabled.

Class com.amazonaws.services.ec2.model.ScheduledInstancesNetworkInterface extends java.lang.Object implements Serializable

Serialized Fields

associatePublicIpAddress

java.lang.Boolean associatePublicIpAddress

Indicates whether to assign a public IP address to instances launched in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

deleteOnTermination

java.lang.Boolean deleteOnTermination

Indicates whether to delete the interface when the instance is terminated.

description

java.lang.String description

The description.

deviceIndex

java.lang.Integer deviceIndex

The index of the device for the network interface attachment.

groups

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> groups

The IDs of one or more security groups.

networkInterfaceId

java.lang.String networkInterfaceId

The ID of the network interface.

privateIpAddress

java.lang.String privateIpAddress

The IP address of the network interface within the subnet.

privateIpAddressConfigs

com.amazonaws.internal.ListWithAutoConstructFlag<ScheduledInstancesPrivateIpAddressConfig> privateIpAddressConfigs

The private IP addresses.

secondaryPrivateIpAddressCount

java.lang.Integer secondaryPrivateIpAddressCount

The number of secondary private IP addresses.

subnetId

java.lang.String subnetId

The ID of the subnet.

Class com.amazonaws.services.ec2.model.ScheduledInstancesPlacement extends java.lang.Object implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone.

groupName

java.lang.String groupName

The name of the placement group.

Class com.amazonaws.services.ec2.model.ScheduledInstancesPrivateIpAddressConfig extends java.lang.Object implements Serializable

Serialized Fields

primary

java.lang.Boolean primary

Indicates whether this is a primary IP address. Otherwise, this is a secondary IP address.

privateIpAddress

java.lang.String privateIpAddress

The IP address.

Class com.amazonaws.services.ec2.model.SecurityGroup extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

A description of the security group.

groupId

java.lang.String groupId

The ID of the security group.

groupName

java.lang.String groupName

The name of the security group.

ipPermissions

com.amazonaws.internal.ListWithAutoConstructFlag<IpPermission> ipPermissions

One or more inbound rules associated with the security group.

ipPermissionsEgress

com.amazonaws.internal.ListWithAutoConstructFlag<IpPermission> ipPermissionsEgress

[EC2-VPC] One or more outbound rules associated with the security group.

ownerId

java.lang.String ownerId

The AWS account ID of the owner of the security group.

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the security group.

vpcId

java.lang.String vpcId

[EC2-VPC] The ID of the VPC for the security group.

Class com.amazonaws.services.ec2.model.SecurityGroupReference extends java.lang.Object implements Serializable

Serialized Fields

groupId

java.lang.String groupId

The ID of your security group.

referencingVpcId

java.lang.String referencingVpcId

The ID of the VPC with the referencing security group.

vpcPeeringConnectionId

java.lang.String vpcPeeringConnectionId

The ID of the VPC peering connection.

Class com.amazonaws.services.ec2.model.SlotDateTimeRangeRequest extends java.lang.Object implements Serializable

Serialized Fields

earliestTime

java.util.Date earliestTime

The earliest date and time, in UTC, for the Scheduled Instance to start.

latestTime

java.util.Date latestTime

The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.

Class com.amazonaws.services.ec2.model.SlotStartTimeRangeRequest extends java.lang.Object implements Serializable

Serialized Fields

earliestTime

java.util.Date earliestTime

The earliest date and time, in UTC, for the Scheduled Instance to start.

latestTime

java.util.Date latestTime

The latest date and time, in UTC, for the Scheduled Instance to start.

Class com.amazonaws.services.ec2.model.Snapshot extends java.lang.Object implements Serializable

Serialized Fields

dataEncryptionKeyId

java.lang.String dataEncryptionKeyId

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

description

java.lang.String description

The description for the snapshot.

encrypted

java.lang.Boolean encrypted

Indicates whether the snapshot is encrypted.

kmsKeyId

java.lang.String kmsKeyId

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

ownerAlias

java.lang.String ownerAlias

The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

ownerId

java.lang.String ownerId

The AWS account ID of the EBS snapshot owner.

progress

java.lang.String progress

The progress of the snapshot, as a percentage.

snapshotId

java.lang.String snapshotId

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

startTime

java.util.Date startTime

The time stamp when the snapshot was initiated.

state

java.lang.String state

The snapshot state.

Constraints:
Allowed Values: pending, completed, error

stateMessage

java.lang.String stateMessage

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the snapshot.

volumeId

java.lang.String volumeId

The ID of the volume that was used to create the snapshot.

volumeSize

java.lang.Integer volumeSize

The size of the volume, in GiB.

Class com.amazonaws.services.ec2.model.SnapshotDetail extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

A description for the snapshot.

deviceName

java.lang.String deviceName

The block device mapping for the snapshot.

diskImageSize

java.lang.Double diskImageSize

The size of the disk in the snapshot, in GiB.

format

java.lang.String format

The format of the disk image from which the snapshot is created.

progress

java.lang.String progress

The percentage of progress for the task.

snapshotId

java.lang.String snapshotId

The snapshot ID of the disk being imported.

status

java.lang.String status

A brief status of the snapshot creation.

statusMessage

java.lang.String statusMessage

A detailed status message for the snapshot creation.

url

java.lang.String url

The URL used to access the disk image.

userBucket

UserBucketDetails userBucket

The S3 bucket for the disk image.

Class com.amazonaws.services.ec2.model.SnapshotDiskContainer extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

The description of the disk image being imported.

format

java.lang.String format

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

url

java.lang.String url

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).

userBucket

UserBucket userBucket

The S3 bucket for the disk image.

Class com.amazonaws.services.ec2.model.SnapshotTaskDetail extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

The description of the snapshot.

diskImageSize

java.lang.Double diskImageSize

The size of the disk in the snapshot, in GiB.

format

java.lang.String format

The format of the disk image from which the snapshot is created.

progress

java.lang.String progress

The percentage of completion for the import snapshot task.

snapshotId

java.lang.String snapshotId

The snapshot ID of the disk being imported.

status

java.lang.String status

A brief status for the import snapshot task.

statusMessage

java.lang.String statusMessage

A detailed status message for the import snapshot task.

url

java.lang.String url

The URL of the disk image from which the snapshot is created.

userBucket

UserBucketDetails userBucket

The S3 bucket for the disk image.

Class com.amazonaws.services.ec2.model.SpotDatafeedSubscription extends java.lang.Object implements Serializable

Serialized Fields

bucket

java.lang.String bucket

The Amazon S3 bucket where the Spot instance data feed is located.

fault

SpotInstanceStateFault fault

The fault codes for the Spot instance request, if any.

ownerId

java.lang.String ownerId

The AWS account ID of the account.

prefix

java.lang.String prefix

The prefix that is prepended to data feed files.

state

java.lang.String state

The state of the Spot instance data feed subscription.

Constraints:
Allowed Values: Active, Inactive

Class com.amazonaws.services.ec2.model.SpotFleetLaunchSpecification extends java.lang.Object implements Serializable

Serialized Fields

addressingType

java.lang.String addressingType

Deprecated.

blockDeviceMappings

com.amazonaws.internal.ListWithAutoConstructFlag<BlockDeviceMapping> blockDeviceMappings

One or more block device mapping entries.

ebsOptimized

java.lang.Boolean ebsOptimized

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

iamInstanceProfile

IamInstanceProfileSpecification iamInstanceProfile

The IAM instance profile.

imageId

java.lang.String imageId

The ID of the AMI.

instanceType

java.lang.String instanceType

The instance type.

Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge

kernelId

java.lang.String kernelId

The ID of the kernel.

keyName

java.lang.String keyName

The name of the key pair.

monitoring

SpotFleetMonitoring monitoring

Enable or disable monitoring for the instances.

networkInterfaces

com.amazonaws.internal.ListWithAutoConstructFlag<InstanceNetworkInterfaceSpecification> networkInterfaces

One or more network interfaces.

placement

SpotPlacement placement

The placement information.

ramdiskId

java.lang.String ramdiskId

The ID of the RAM disk.

securityGroups

com.amazonaws.internal.ListWithAutoConstructFlag<GroupIdentifier> securityGroups

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

spotPrice

java.lang.String spotPrice

The bid price per unit hour for the specified instance type. If this value is not specified, the default is the Spot bid price specified for the fleet. To determine the bid price per unit hour, divide the Spot bid price by the value of WeightedCapacity.

subnetId

java.lang.String subnetId

The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-a61dafcf, subnet-65ea5f08".

userData

java.lang.String userData

The Base64-encoded MIME user data to make available to the instances.

weightedCapacity

java.lang.Double weightedCapacity

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O).

If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.

Class com.amazonaws.services.ec2.model.SpotFleetMonitoring extends java.lang.Object implements Serializable

Serialized Fields

enabled

java.lang.Boolean enabled

Enables monitoring for the instance.

Default: false

Class com.amazonaws.services.ec2.model.SpotFleetRequestConfig extends java.lang.Object implements Serializable

Serialized Fields

createTime

java.util.Date createTime

The creation date and time of the request.

spotFleetRequestConfig

SpotFleetRequestConfigData spotFleetRequestConfig

Information about the configuration of the Spot fleet request.

spotFleetRequestId

java.lang.String spotFleetRequestId

The ID of the Spot fleet request.

spotFleetRequestState

java.lang.String spotFleetRequestState

The state of the Spot fleet request.

Constraints:
Allowed Values: submitted, active, cancelled, failed, cancelled_running, cancelled_terminating, modifying

Class com.amazonaws.services.ec2.model.SpotFleetRequestConfigData extends java.lang.Object implements Serializable

Serialized Fields

allocationStrategy

java.lang.String allocationStrategy

Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is lowestPrice.

Constraints:
Allowed Values: lowestPrice, diversified

clientToken

java.lang.String clientToken

A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

excessCapacityTerminationPolicy

java.lang.String excessCapacityTerminationPolicy

Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.

Constraints:
Allowed Values: noTermination, default

fulfilledCapacity

java.lang.Double fulfilledCapacity

The number of units fulfilled by this request compared to the set target capacity.

iamFleetRole

java.lang.String iamFleetRole

Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration.

launchSpecifications

com.amazonaws.internal.ListWithAutoConstructFlag<SpotFleetLaunchSpecification> launchSpecifications

Information about the launch specifications for the Spot fleet request.

Constraints:
Length: 1 -

spotPrice

java.lang.String spotPrice

The bid price per unit hour.

targetCapacity

java.lang.Integer targetCapacity

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O.

terminateInstancesWithExpiration

java.lang.Boolean terminateInstancesWithExpiration

Indicates whether running Spot instances should be terminated when the Spot fleet request expires.

type

java.lang.String type

The type of request. Indicates whether the fleet will only request the target capacity or also attempt to maintain it. When you request a certain target capacity, the fleet will only place the required bids. It will not attempt to replenish Spot instances if capacity is diminished, nor will it submit bids in alternative Spot pools if capacity is not available. When you want to maintain a certain target capacity, fleet will place the required bids to meet this target capacity. It will also automatically replenish any interrupted instances. Default: maintain.

Constraints:
Allowed Values: request, maintain

validFrom

java.util.Date validFrom

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

validUntil

java.util.Date validUntil

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot instance requests are placed or enabled to fulfill the request.

Class com.amazonaws.services.ec2.model.SpotInstanceRequest extends java.lang.Object implements Serializable

Serialized Fields

actualBlockHourlyPrice

java.lang.String actualBlockHourlyPrice

If you specified a duration and your Spot instance request was fulfilled, this is the fixed hourly price in effect for the Spot instance while it runs.

availabilityZoneGroup

java.lang.String availabilityZoneGroup

The Availability Zone group. If you specify the same Availability Zone group for all Spot instance requests, all Spot instances are launched in the same Availability Zone.

blockDurationMinutes

java.lang.Integer blockDurationMinutes

The duration for the Spot instance, in minutes.

createTime

java.util.Date createTime

The date and time when the Spot instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

fault

SpotInstanceStateFault fault

The fault codes for the Spot instance request, if any.

instanceId

java.lang.String instanceId

The instance ID, if an instance has been launched to fulfill the Spot instance request.

launchedAvailabilityZone

java.lang.String launchedAvailabilityZone

The Availability Zone in which the bid is launched.

launchGroup

java.lang.String launchGroup

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

launchSpecification

LaunchSpecification launchSpecification

Additional information for launching instances.

productDescription

java.lang.String productDescription

The product description associated with the Spot instance.

Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)

spotInstanceRequestId

java.lang.String spotInstanceRequestId

The ID of the Spot instance request.

spotPrice

java.lang.String spotPrice

The maximum hourly price (bid) for the Spot instance launched to fulfill the request.

state

java.lang.String state

The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

Constraints:
Allowed Values: open, active, closed, cancelled, failed

status

SpotInstanceStatus status

The status code and status message describing the Spot instance request.

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the resource.

type

java.lang.String type

The Spot instance request type.

Constraints:
Allowed Values: one-time, persistent

validFrom

java.util.Date validFrom

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.

validUntil

java.util.Date validUntil

The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, it remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.

Class com.amazonaws.services.ec2.model.SpotInstanceStateFault extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.String code

The reason code for the Spot instance state change.

message

java.lang.String message

The message for the Spot instance state change.

Class com.amazonaws.services.ec2.model.SpotInstanceStatus extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.String code

The status code. For a list of status codes, see Spot Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.

message

java.lang.String message

The description for the status code.

updateTime

java.util.Date updateTime

The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Class com.amazonaws.services.ec2.model.SpotPlacement extends java.lang.Object implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone.

[Spot fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".

groupName

java.lang.String groupName

The name of the placement group (for cluster instances).

Class com.amazonaws.services.ec2.model.SpotPrice extends java.lang.Object implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone.

instanceType

java.lang.String instanceType

The instance type.

Constraints:
Allowed Values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, x1.4xlarge, x1.8xlarge, x1.16xlarge, x1.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, cg1.4xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge

productDescription

java.lang.String productDescription

A general description of the AMI.

Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)

spotPrice

java.lang.String spotPrice

The maximum price (bid) that you are willing to pay for a Spot instance.

timestamp

java.util.Date timestamp

The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Class com.amazonaws.services.ec2.model.StaleIpPermission extends java.lang.Object implements Serializable

Serialized Fields

fromPort

java.lang.Integer fromPort

The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

ipProtocol

java.lang.String ipProtocol

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

ipRanges

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> ipRanges

One or more IP ranges. Not applicable for stale security group rules.

prefixListIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> prefixListIds

One or more prefix list IDs for an AWS service. Not applicable for stale security group rules.

toPort

java.lang.Integer toPort

The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

userIdGroupPairs

com.amazonaws.internal.ListWithAutoConstructFlag<UserIdGroupPair> userIdGroupPairs

One or more security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.

Class com.amazonaws.services.ec2.model.StaleSecurityGroup extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

The description of the security group.

groupId

java.lang.String groupId

The ID of the security group.

groupName

java.lang.String groupName

The name of the security group.

staleIpPermissions

com.amazonaws.internal.ListWithAutoConstructFlag<StaleIpPermission> staleIpPermissions

Information about the stale inbound rules in the security group.

staleIpPermissionsEgress

com.amazonaws.internal.ListWithAutoConstructFlag<StaleIpPermission> staleIpPermissionsEgress

Information about the stale outbound rules in the security group.

vpcId

java.lang.String vpcId

The ID of the VPC for the security group.

Class com.amazonaws.services.ec2.model.StartInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

additionalInfo

java.lang.String additionalInfo

Reserved.

instanceIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> instanceIds

One or more instance IDs.

Class com.amazonaws.services.ec2.model.StartInstancesResult extends java.lang.Object implements Serializable

Serialized Fields

startingInstances

com.amazonaws.internal.ListWithAutoConstructFlag<InstanceStateChange> startingInstances

Information about one or more started instances.

Class com.amazonaws.services.ec2.model.StateReason extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.String code

The reason code for the state change.

message

java.lang.String message

The message for the state change.

• Server.SpotInstanceTermination: A Spot instance was terminated due to an increase in the market price.

• Server.InternalError: An internal error occurred during instance launch, resulting in termination.

• Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.

• Client.InternalError: A client error caused the instance to terminate on launch.

• Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

• Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

• Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your limits.

• Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

Class com.amazonaws.services.ec2.model.StopInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

force

java.lang.Boolean force

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

instanceIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> instanceIds

One or more instance IDs.

Class com.amazonaws.services.ec2.model.StopInstancesResult extends java.lang.Object implements Serializable

Serialized Fields

stoppingInstances

com.amazonaws.internal.ListWithAutoConstructFlag<InstanceStateChange> stoppingInstances

Information about one or more stopped instances.

Class com.amazonaws.services.ec2.model.Storage extends java.lang.Object implements Serializable

Serialized Fields

s3

S3Storage s3

An Amazon S3 storage location.

Class com.amazonaws.services.ec2.model.Subnet extends java.lang.Object implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone of the subnet.

availableIpAddressCount

java.lang.Integer availableIpAddressCount

The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.

cidrBlock

java.lang.String cidrBlock

The CIDR block assigned to the subnet.

defaultForAz

java.lang.Boolean defaultForAz

Indicates whether this is the default subnet for the Availability Zone.

mapPublicIpOnLaunch

java.lang.Boolean mapPublicIpOnLaunch

Indicates whether instances launched in this subnet receive a public IP address.

state

java.lang.String state

The current state of the subnet.

Constraints:
Allowed Values: pending, available

subnetId

java.lang.String subnetId

The ID of the subnet.

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the subnet.

vpcId

java.lang.String vpcId

The ID of the VPC the subnet is in.

Class com.amazonaws.services.ec2.model.Tag extends java.lang.Object implements Serializable

Serialized Fields

key

java.lang.String key

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

value

java.lang.String value

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

Class com.amazonaws.services.ec2.model.TagDescription extends java.lang.Object implements Serializable

Serialized Fields

key

java.lang.String key

The tag key.

resourceId

java.lang.String resourceId

The ID of the resource. For example, ami-1a2b3c4d.

resourceType

java.lang.String resourceType

The resource type.

Constraints:
Allowed Values: customer-gateway, dhcp-options, image, instance, internet-gateway, network-acl, network-interface, reserved-instances, route-table, snapshot, spot-instances-request, subnet, security-group, volume, vpc, vpn-connection, vpn-gateway

value

java.lang.String value

The tag value.

Class com.amazonaws.services.ec2.model.TerminateInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> instanceIds

One or more instance IDs.

Class com.amazonaws.services.ec2.model.TerminateInstancesResult extends java.lang.Object implements Serializable

Serialized Fields

terminatingInstances

com.amazonaws.internal.ListWithAutoConstructFlag<InstanceStateChange> terminatingInstances

Information about one or more terminated instances.

Class com.amazonaws.services.ec2.model.UnassignPrivateIpAddressesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkInterfaceId

java.lang.String networkInterfaceId

The ID of the network interface.

privateIpAddresses

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> privateIpAddresses

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

Class com.amazonaws.services.ec2.model.UnmonitorInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> instanceIds

One or more instance IDs.

Class com.amazonaws.services.ec2.model.UnmonitorInstancesResult extends java.lang.Object implements Serializable

Serialized Fields

instanceMonitorings

com.amazonaws.internal.ListWithAutoConstructFlag<InstanceMonitoring> instanceMonitorings

Monitoring information for one or more instances.

Class com.amazonaws.services.ec2.model.UnsuccessfulItem extends java.lang.Object implements Serializable

Serialized Fields

error

UnsuccessfulItemError error

Information about the error.

resourceId

java.lang.String resourceId

The ID of the resource.

Class com.amazonaws.services.ec2.model.UnsuccessfulItemError extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.String code

The error code.

message

java.lang.String message

The error message accompanying the error code.

Class com.amazonaws.services.ec2.model.UserBucket extends java.lang.Object implements Serializable

Serialized Fields

s3Bucket

java.lang.String s3Bucket

The name of the S3 bucket where the disk image is located.

s3Key

java.lang.String s3Key

The file name of the disk image.

Class com.amazonaws.services.ec2.model.UserBucketDetails extends java.lang.Object implements Serializable

Serialized Fields

s3Bucket

java.lang.String s3Bucket

The S3 bucket from which the disk image was created.

s3Key

java.lang.String s3Key

The file name of the disk image.

Class com.amazonaws.services.ec2.model.UserData extends java.lang.Object implements Serializable

Serialized Fields

data

java.lang.String data

The Base64-encoded MIME user data for the instance.

Class com.amazonaws.services.ec2.model.UserIdGroupPair extends java.lang.Object implements Serializable

Serialized Fields

groupId

java.lang.String groupId

The ID of the security group.

groupName

java.lang.String groupName

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.

peeringStatus

java.lang.String peeringStatus

The status of a VPC peering connection, if applicable.

userId

java.lang.String userId

The ID of an AWS account. For a referenced security group in another VPC, the account ID of the referenced security group is returned.

[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account.

vpcId

java.lang.String vpcId

The ID of the VPC for the referenced security group, if applicable.

vpcPeeringConnectionId

java.lang.String vpcPeeringConnectionId

The ID of the VPC peering connection, if applicable.

Class com.amazonaws.services.ec2.model.VgwTelemetry extends java.lang.Object implements Serializable

Serialized Fields

acceptedRouteCount

java.lang.Integer acceptedRouteCount

The number of accepted routes.

lastStatusChange

java.util.Date lastStatusChange

The date and time of the last change in status.

outsideIpAddress

java.lang.String outsideIpAddress

The Internet-routable IP address of the virtual private gateway's outside interface.

status

java.lang.String status

The status of the VPN tunnel.

Constraints:
Allowed Values: UP, DOWN

statusMessage

java.lang.String statusMessage

If an error occurs, a description of the error.

Class com.amazonaws.services.ec2.model.Volume extends java.lang.Object implements Serializable

Serialized Fields

attachments

com.amazonaws.internal.ListWithAutoConstructFlag<VolumeAttachment> attachments

Information about the volume attachments.

availabilityZone

java.lang.String availabilityZone

The Availability Zone for the volume.

createTime

java.util.Date createTime

The time stamp when volume creation was initiated.

encrypted

java.lang.Boolean encrypted

Indicates whether the volume will be encrypted.

iops

java.lang.Integer iops

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

kmsKeyId

java.lang.String kmsKeyId

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

size

java.lang.Integer size

The size of the volume, in GiBs.

snapshotId

java.lang.String snapshotId

The snapshot from which the volume was created, if applicable.

state

java.lang.String state

The volume state.

Constraints:
Allowed Values: creating, available, in-use, deleting, deleted, error

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the volume.

volumeId

java.lang.String volumeId

The ID of the volume.

volumeType

java.lang.String volumeType

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Constraints:
Allowed Values: standard, io1, gp2, sc1, st1

Class com.amazonaws.services.ec2.model.VolumeAttachment extends java.lang.Object implements Serializable

Serialized Fields

attachTime

java.util.Date attachTime

The time stamp when the attachment initiated.

deleteOnTermination

java.lang.Boolean deleteOnTermination

Indicates whether the EBS volume is deleted on instance termination.

device

java.lang.String device

The device name.

instanceId

java.lang.String instanceId

The ID of the instance.

state

java.lang.String state

The attachment state of the volume.

Constraints:
Allowed Values: attaching, attached, detaching, detached

volumeId

java.lang.String volumeId

The ID of the volume.

Class com.amazonaws.services.ec2.model.VolumeDetail extends java.lang.Object implements Serializable

Serialized Fields

size

java.lang.Long size

The size of the volume, in GiB.

Class com.amazonaws.services.ec2.model.VolumeStatusAction extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.String code

The code identifying the operation, for example, enable-volume-io.

description

java.lang.String description

A description of the operation.

eventId

java.lang.String eventId

The ID of the event associated with this operation.

eventType

java.lang.String eventType

The event type associated with this operation.

Class com.amazonaws.services.ec2.model.VolumeStatusDetails extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the volume status.

Constraints:
Allowed Values: io-enabled, io-performance

status

java.lang.String status

The intended status of the volume status.

Class com.amazonaws.services.ec2.model.VolumeStatusEvent extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

A description of the event.

eventId

java.lang.String eventId

The ID of this event.

eventType

java.lang.String eventType

The type of this event.

notAfter

java.util.Date notAfter

The latest end time of the event.

notBefore

java.util.Date notBefore

The earliest start time of the event.

Class com.amazonaws.services.ec2.model.VolumeStatusInfo extends java.lang.Object implements Serializable

Serialized Fields

details

com.amazonaws.internal.ListWithAutoConstructFlag<VolumeStatusDetails> details

The details of the volume status.

status

java.lang.String status

The status of the volume.

Constraints:
Allowed Values: ok, impaired, insufficient-data

Class com.amazonaws.services.ec2.model.VolumeStatusItem extends java.lang.Object implements Serializable

Serialized Fields

actions

com.amazonaws.internal.ListWithAutoConstructFlag<VolumeStatusAction> actions

The details of the operation.

availabilityZone

java.lang.String availabilityZone

The Availability Zone of the volume.

events

com.amazonaws.internal.ListWithAutoConstructFlag<VolumeStatusEvent> events

A list of events associated with the volume.

volumeId

java.lang.String volumeId

The volume ID.

volumeStatus

VolumeStatusInfo volumeStatus

The volume status.

Class com.amazonaws.services.ec2.model.Vpc extends java.lang.Object implements Serializable

Serialized Fields

cidrBlock

java.lang.String cidrBlock

The CIDR block for the VPC.

dhcpOptionsId

java.lang.String dhcpOptionsId

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

instanceTenancy

java.lang.String instanceTenancy

The allowed tenancy of instances launched into the VPC.

Constraints:
Allowed Values: default, dedicated, host

isDefault

java.lang.Boolean isDefault

Indicates whether the VPC is the default VPC.

state

java.lang.String state

The current state of the VPC.

Constraints:
Allowed Values: pending, available

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the VPC.

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.VpcAttachment extends java.lang.Object implements Serializable

Serialized Fields

state

java.lang.String state

The current state of the attachment.

Constraints:
Allowed Values: attaching, attached, detaching, detached

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.VpcClassicLink extends java.lang.Object implements Serializable

Serialized Fields

classicLinkEnabled

java.lang.Boolean classicLinkEnabled

Indicates whether the VPC is enabled for ClassicLink.

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the VPC.

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.VpcEndpoint extends java.lang.Object implements Serializable

Serialized Fields

creationTimestamp

java.util.Date creationTimestamp

The date and time the VPC endpoint was created.

policyDocument

java.lang.String policyDocument

The policy document associated with the endpoint.

routeTableIds

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> routeTableIds

One or more route tables associated with the endpoint.

serviceName

java.lang.String serviceName

The name of the AWS service to which the endpoint is associated.

state

java.lang.String state

The state of the VPC endpoint.

Constraints:
Allowed Values: Pending, Available, Deleting, Deleted

vpcEndpointId

java.lang.String vpcEndpointId

The ID of the VPC endpoint.

vpcId

java.lang.String vpcId

The ID of the VPC to which the endpoint is associated.

Class com.amazonaws.services.ec2.model.VpcPeeringConnection extends java.lang.Object implements Serializable

Serialized Fields

accepterVpcInfo

VpcPeeringConnectionVpcInfo accepterVpcInfo

Information about the accepter VPC. CIDR block information is not returned when creating a VPC peering connection, or when describing a VPC peering connection that's in the initiating-request or pending-acceptance state.

expirationTime

java.util.Date expirationTime

The time that an unaccepted VPC peering connection will expire.

requesterVpcInfo

VpcPeeringConnectionVpcInfo requesterVpcInfo

Information about the requester VPC.

status

VpcPeeringConnectionStateReason status

The status of the VPC peering connection.

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the resource.

vpcPeeringConnectionId

java.lang.String vpcPeeringConnectionId

The ID of the VPC peering connection.

Class com.amazonaws.services.ec2.model.VpcPeeringConnectionOptionsDescription extends java.lang.Object implements Serializable

Serialized Fields

allowEgressFromLocalClassicLinkToRemoteVpc

java.lang.Boolean allowEgressFromLocalClassicLinkToRemoteVpc

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

allowEgressFromLocalVpcToRemoteClassicLink

java.lang.Boolean allowEgressFromLocalVpcToRemoteClassicLink

Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.

Class com.amazonaws.services.ec2.model.VpcPeeringConnectionStateReason extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.String code

The status of the VPC peering connection.

Constraints:
Allowed Values: initiating-request, pending-acceptance, active, deleted, rejected, failed, expired, provisioning, deleting

message

java.lang.String message

A message that provides more information about the status, if applicable.

Class com.amazonaws.services.ec2.model.VpcPeeringConnectionVpcInfo extends java.lang.Object implements Serializable

Serialized Fields

cidrBlock

java.lang.String cidrBlock

The CIDR block for the VPC.

ownerId

java.lang.String ownerId

The AWS account ID of the VPC owner.

peeringOptions

VpcPeeringConnectionOptionsDescription peeringOptions

Information about the VPC peering connection options for the accepter or requester VPC.

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.VpnConnection extends java.lang.Object implements Serializable

Serialized Fields

customerGatewayConfiguration

java.lang.String customerGatewayConfiguration

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

customerGatewayId

java.lang.String customerGatewayId

The ID of the customer gateway at your end of the VPN connection.

options

VpnConnectionOptions options

The VPN connection options.

routes

com.amazonaws.internal.ListWithAutoConstructFlag<VpnStaticRoute> routes

The static routes associated with the VPN connection.

state

java.lang.String state

The current state of the VPN connection.

Constraints:
Allowed Values: pending, available, deleting, deleted

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the VPN connection.

type

java.lang.String type

The type of VPN connection.

Constraints:
Allowed Values: ipsec.1

vgwTelemetry

com.amazonaws.internal.ListWithAutoConstructFlag<VgwTelemetry> vgwTelemetry

Information about the VPN tunnel.

vpnConnectionId

java.lang.String vpnConnectionId

The ID of the VPN connection.

vpnGatewayId

java.lang.String vpnGatewayId

The ID of the virtual private gateway at the AWS side of the VPN connection.

Class com.amazonaws.services.ec2.model.VpnConnectionOptions extends java.lang.Object implements Serializable

Serialized Fields

staticRoutesOnly

java.lang.Boolean staticRoutesOnly

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

Class com.amazonaws.services.ec2.model.VpnConnectionOptionsSpecification extends java.lang.Object implements Serializable

Serialized Fields

staticRoutesOnly

java.lang.Boolean staticRoutesOnly

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

Class com.amazonaws.services.ec2.model.VpnGateway extends java.lang.Object implements Serializable

Serialized Fields

availabilityZone

java.lang.String availabilityZone

The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

state

java.lang.String state

The current state of the virtual private gateway.

Constraints:
Allowed Values: pending, available, deleting, deleted

tags

com.amazonaws.internal.ListWithAutoConstructFlag<Tag> tags

Any tags assigned to the virtual private gateway.

type

java.lang.String type

The type of VPN connection the virtual private gateway supports.

Constraints:
Allowed Values: ipsec.1

vpcAttachments

com.amazonaws.internal.ListWithAutoConstructFlag<VpcAttachment> vpcAttachments

Any VPCs attached to the virtual private gateway.

vpnGatewayId

java.lang.String vpnGatewayId

The ID of the virtual private gateway.

Class com.amazonaws.services.ec2.model.VpnStaticRoute extends java.lang.Object implements Serializable

Serialized Fields

destinationCidrBlock

java.lang.String destinationCidrBlock

The CIDR block associated with the local subnet of the customer data center.

source

java.lang.String source

Indicates how the routes were provided.

Constraints:
Allowed Values: Static

state

java.lang.String state

The current state of the static route.

Constraints:
Allowed Values: pending, available, deleting, deleted

Package com.amazonaws.services.geo.model

Class com.amazonaws.services.geo.model.AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.geo.model.AssociateTrackerConsumerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

consumerArn

java.lang.String consumerArn

The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

trackerName

java.lang.String trackerName

The name of the tracker resource to be associated with a geofence collection.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.AssociateTrackerConsumerResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.geo.model.BatchDeleteDevicePositionHistoryError extends java.lang.Object implements Serializable

Serialized Fields

deviceId

java.lang.String deviceId

The ID of the device for this position.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

error

BatchItemError error

Contains the batch request error details associated with the request.

Class com.amazonaws.services.geo.model.BatchDeleteDevicePositionHistoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deviceIds

java.util.List<java.lang.String> deviceIds

Devices whose position history you want to delete.

• For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2]

trackerName

java.lang.String trackerName

The name of the tracker resource to delete the device position history from.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.BatchDeleteDevicePositionHistoryResult extends java.lang.Object implements Serializable

Serialized Fields

errors

java.util.List<BatchDeleteDevicePositionHistoryError> errors

Contains error details for each device history that failed to delete.

Class com.amazonaws.services.geo.model.BatchDeleteGeofenceError extends java.lang.Object implements Serializable

Serialized Fields

error

BatchItemError error

Contains details associated to the batch error.

geofenceId

java.lang.String geofenceId

The geofence associated with the error message.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

Class com.amazonaws.services.geo.model.BatchDeleteGeofenceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionName

java.lang.String collectionName

The geofence collection storing the geofences to be deleted.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

geofenceIds

java.util.List<java.lang.String> geofenceIds

The batch of geofences to be deleted.

Class com.amazonaws.services.geo.model.BatchDeleteGeofenceResult extends java.lang.Object implements Serializable

Serialized Fields

errors

java.util.List<BatchDeleteGeofenceError> errors

Contains error details for each geofence that failed to delete.

Class com.amazonaws.services.geo.model.BatchEvaluateGeofencesError extends java.lang.Object implements Serializable

Serialized Fields

deviceId

java.lang.String deviceId

The device associated with the position evaluation error.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

error

BatchItemError error

Contains details associated to the batch error.

sampleTime

java.util.Date sampleTime

Specifies a timestamp for when the error occurred in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Class com.amazonaws.services.geo.model.BatchEvaluateGeofencesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionName

java.lang.String collectionName

The geofence collection used in evaluating the position of devices against its geofences.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

devicePositionUpdates

java.util.List<DevicePositionUpdate> devicePositionUpdates

Contains device details for each device to be evaluated against the given geofence collection.

Class com.amazonaws.services.geo.model.BatchEvaluateGeofencesResult extends java.lang.Object implements Serializable

Serialized Fields

errors

java.util.List<BatchEvaluateGeofencesError> errors

Contains error details for each device that failed to evaluate its position against the given geofence collection.

Class com.amazonaws.services.geo.model.BatchGetDevicePositionError extends java.lang.Object implements Serializable

Serialized Fields

deviceId

java.lang.String deviceId

The ID of the device that didn't return a position.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

error

BatchItemError error

Contains details related to the error code.

Class com.amazonaws.services.geo.model.BatchGetDevicePositionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deviceIds

java.util.List<java.lang.String> deviceIds

Devices whose position you want to retrieve.

• For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2

trackerName

java.lang.String trackerName

The tracker resource retrieving the device position.

Constraints:
Length: 1 -
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.BatchGetDevicePositionResult extends java.lang.Object implements Serializable

Serialized Fields

devicePositions

java.util.List<DevicePosition> devicePositions

Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled.

errors

java.util.List<BatchGetDevicePositionError> errors

Contains error details for each device that failed to send its position to the tracker resource.

Class com.amazonaws.services.geo.model.BatchItemError extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.String code

The error code associated with the batch request error.

Constraints:
Allowed Values: AccessDeniedError, ConflictError, InternalServerError, ResourceNotFoundError, ThrottlingError, ValidationError

message

java.lang.String message

A message with the reason for the batch request error.

Class com.amazonaws.services.geo.model.BatchPutGeofenceError extends java.lang.Object implements Serializable

Serialized Fields

error

BatchItemError error

Contains details associated to the batch error.

geofenceId

java.lang.String geofenceId

The geofence associated with the error message.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

Class com.amazonaws.services.geo.model.BatchPutGeofenceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionName

java.lang.String collectionName

The geofence collection storing the geofences.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

entries

java.util.List<BatchPutGeofenceRequestEntry> entries

The batch of geofences to be stored in a geofence collection.

Class com.amazonaws.services.geo.model.BatchPutGeofenceRequestEntry extends java.lang.Object implements Serializable

Serialized Fields

geofenceId

java.lang.String geofenceId

The identifier for the geofence to be stored in a given geofence collection.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

geometry

GeofenceGeometry geometry

Contains the details of the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.

Each geofence polygon can have a maximum of 1,000 vertices.

Class com.amazonaws.services.geo.model.BatchPutGeofenceResult extends java.lang.Object implements Serializable

Serialized Fields

errors

java.util.List<BatchPutGeofenceError> errors

Contains additional error details for each geofence that failed to be stored in a geofence collection.

successes

java.util.List<BatchPutGeofenceSuccess> successes

Contains each geofence that was successfully stored in a geofence collection.

Class com.amazonaws.services.geo.model.BatchPutGeofenceSuccess extends java.lang.Object implements Serializable

Serialized Fields

createTime

java.util.Date createTime

The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

geofenceId

java.lang.String geofenceId

The geofence successfully stored in a geofence collection.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

updateTime

java.util.Date updateTime

The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Class com.amazonaws.services.geo.model.BatchUpdateDevicePositionError extends java.lang.Object implements Serializable

Serialized Fields

deviceId

java.lang.String deviceId

The device associated with the failed location update.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

error

BatchItemError error

Contains details related to the error code such as the error code and error message.

sampleTime

java.util.Date sampleTime

The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Class com.amazonaws.services.geo.model.BatchUpdateDevicePositionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

trackerName

java.lang.String trackerName

The name of the tracker resource to update.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

updates

java.util.List<DevicePositionUpdate> updates

Contains the position update details for each device.

Class com.amazonaws.services.geo.model.BatchUpdateDevicePositionResult extends java.lang.Object implements Serializable

Serialized Fields

errors

java.util.List<BatchUpdateDevicePositionError> errors

Contains error details for each device that failed to update its position.

Class com.amazonaws.services.geo.model.CalculateRouteCarModeOptions extends java.lang.Object implements Serializable

Serialized Fields

avoidFerries

java.lang.Boolean avoidFerries

Avoids ferries when calculating routes.

Default Value: false

Valid Values: false | true

avoidTolls

java.lang.Boolean avoidTolls

Avoids tolls when calculating routes.

Default Value: false

Valid Values: false | true

Class com.amazonaws.services.geo.model.CalculateRouteMatrixRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

calculatorName

java.lang.String calculatorName

The name of the route calculator resource that you want to use to calculate the route matrix.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

carModeOptions

CalculateRouteCarModeOptions carModeOptions

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

departNow

java.lang.Boolean departNow

Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

Default Value: false

Valid Values: false | true

departurePositions

java.util.List<java.util.List<java.lang.Double>> departurePositions

The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-123.115, 49.285].

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions.

Valid Values: [-180 to 180,-90 to 90]

departureTime

java.util.Date departureTime

Specifies the desired time of departure. Uses the given time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.

Setting a departure time in the past returns a 400 ValidationException error.

• In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

destinationPositions

java.util.List<java.util.List<java.lang.Double>> destinationPositions

The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-122.339, 47.615]

Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.

For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions.

Valid Values: [-180 to 180,-90 to 90]

distanceUnit

java.lang.String distanceUnit

Set the unit system to specify the distance.

Default Value: Kilometers

Constraints:
Allowed Values: Kilometers, Miles

travelMode

java.lang.String travelMode

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

The TravelMode you specify also determines how you specify route preferences:

• If traveling by Car use the CarModeOptions parameter.

• If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

Constraints:
Allowed Values: Car, Truck, Walking

truckModeOptions

CalculateRouteTruckModeOptions truckModeOptions

Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

Class com.amazonaws.services.geo.model.CalculateRouteMatrixResult extends java.lang.Object implements Serializable

Serialized Fields

routeMatrix

java.util.List<java.util.List<RouteMatrixEntry>> routeMatrix

The calculated route matrix containing the results for all pairs of DeparturePositions to DestinationPositions. Each row corresponds to one entry in DeparturePositions. Each entry in the row corresponds to the route from that entry in DeparturePositions to an entry in DestinationPositions.

snappedDeparturePositions

java.util.List<java.util.List<java.lang.Double>> snappedDeparturePositions

For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the RouteMatrix.

snappedDestinationPositions

java.util.List<java.util.List<java.lang.Double>> snappedDestinationPositions

The list of destination positions for the route matrix used for calculation of the RouteMatrix.

summary

CalculateRouteMatrixSummary summary

Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.

Class com.amazonaws.services.geo.model.CalculateRouteMatrixSummary extends java.lang.Object implements Serializable

Serialized Fields

dataSource

java.lang.String dataSource

The data provider of traffic and road network data used to calculate the routes. Indicates one of the available providers:

• Esri

• Here

For more information about data providers, see Amazon Location Service data providers.

distanceUnit

java.lang.String distanceUnit

The unit of measurement for route distances.

Constraints:
Allowed Values: Kilometers, Miles

errorCount

java.lang.Integer errorCount

The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

Constraints:
Range: 1 - 160000

routeCount

java.lang.Integer routeCount

The count of cells in the route matrix. Equal to the number of DeparturePositions multiplied by the number of DestinationPositions.

Constraints:
Range: 1 - 160000

Class com.amazonaws.services.geo.model.CalculateRouteRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

calculatorName

java.lang.String calculatorName

The name of the route calculator resource that you want to use to calculate the route.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

carModeOptions

CalculateRouteCarModeOptions carModeOptions

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

departNow

java.lang.Boolean departNow

Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

departurePosition

java.util.List<java.lang.Double> departurePosition

The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

departureTime

java.util.Date departureTime

Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Setting a departure time in the past returns a 400 ValidationException error.

• In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

destinationPosition

java.util.List<java.lang.Double> destinationPosition

The finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].

• For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

distanceUnit

java.lang.String distanceUnit

Set the unit system to specify the distance.

Default Value: Kilometers

Constraints:
Allowed Values: Kilometers, Miles

includeLegGeometry

java.lang.Boolean includeLegGeometry

Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

travelMode

java.lang.String travelMode

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, or Walking as options for the TravelMode.

The TravelMode you specify also determines how you specify route preferences:

• If traveling by Car use the CarModeOptions parameter.

• If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

Constraints:
Allowed Values: Car, Truck, Walking

truckModeOptions

CalculateRouteTruckModeOptions truckModeOptions

Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

waypointPositions

java.util.List<java.util.List<java.lang.Double>> waypointPositions

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

• For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Class com.amazonaws.services.geo.model.CalculateRouteResult extends java.lang.Object implements Serializable

Serialized Fields

legs

java.util.List<Leg> legs

Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.

For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:

• The StartPosition is the departure position.

• The EndPosition is the destination position.

A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

• Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.

• Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.

summary

CalculateRouteSummary summary

Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.

Class com.amazonaws.services.geo.model.CalculateRouteSummary extends java.lang.Object implements Serializable

Serialized Fields

dataSource

java.lang.String dataSource

The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:

• Esri

• Here

For more information about data providers, see Amazon Location Service data providers.

distance

java.lang.Double distance

The total distance covered by the route. The sum of the distance travelled between every stop on the route.

If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a 400 RoutesValidationException error.

Constraints:
Range: 0.0 -

distanceUnit

java.lang.String distanceUnit

The unit of measurement for route distances.

Constraints:
Allowed Values: Kilometers, Miles

durationSeconds

java.lang.Double durationSeconds

The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

Constraints:
Range: 0.0 -

routeBBox

java.util.List<java.lang.Double> routeBBox

Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y].

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

The next 2 bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or latitude of the upper northeast corner.

Class com.amazonaws.services.geo.model.CalculateRouteTruckModeOptions extends java.lang.Object implements Serializable

Serialized Fields

avoidFerries

java.lang.Boolean avoidFerries

Avoids ferries when calculating routes.

Default Value: false

Valid Values: false | true

avoidTolls

java.lang.Boolean avoidTolls

Avoids tolls when calculating routes.

Default Value: false

Valid Values: false | true

dimensions

TruckDimensions dimensions

Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.

weight

TruckWeight weight

Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.

Class com.amazonaws.services.geo.model.Circle extends java.lang.Object implements Serializable

Serialized Fields

center

java.util.List<java.lang.Double> center

A single point geometry, specifying the center of the circle, using WGS 84 coordinates, in the form [longitude, latitude].

radius

java.lang.Double radius

The radius of the circle in meters. Must be greater than zero and no larger than 100,000 (100 kilometers).

Class com.amazonaws.services.geo.model.ConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.geo.model.CreateGeofenceCollectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionName

java.lang.String collectionName

A custom name for the geofence collection.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique geofence collection name.

• No spaces allowed. For example, ExampleGeofenceCollection.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

description

java.lang.String description

An optional description for the geofence collection.

Constraints:
Length: 0 - 1000

kmsKeyId

java.lang.String kmsKeyId

A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

Constraints:
Length: 1 - 2048

pricingPlan

java.lang.String pricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

pricingPlanDataSource

java.lang.String pricingPlanDataSource

This parameter is no longer used.

tags

java.util.Map<java.lang.String,java.lang.String> tags

Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

Class com.amazonaws.services.geo.model.CreateGeofenceCollectionResult extends java.lang.Object implements Serializable

Serialized Fields

collectionArn

java.lang.String collectionArn

The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

collectionName

java.lang.String collectionName

The name for the geofence collection.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

createTime

java.util.Date createTime

The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Class com.amazonaws.services.geo.model.CreateMapRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configuration

MapConfiguration configuration

Specifies the map style selected from an available data provider.

description

java.lang.String description

An optional description for the map resource.

Constraints:
Length: 0 - 1000

mapName

java.lang.String mapName

The name for the map resource.

Requirements:

• Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique map resource name.

• No spaces allowed. For example, ExampleMap.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

pricingPlan

java.lang.String pricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

tags

java.util.Map<java.lang.String,java.lang.String> tags

Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

Class com.amazonaws.services.geo.model.CreateMapResult extends java.lang.Object implements Serializable

Serialized Fields

createTime

java.util.Date createTime

The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

mapArn

java.lang.String mapArn

The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:maps/ExampleMap

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

mapName

java.lang.String mapName

The name of the map resource.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.CreatePlaceIndexRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dataSource

java.lang.String dataSource

Specifies the geospatial data provider for the new place index.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

• Esri – For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage.

• Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.

  If you specify HERE Technologies (Here) as the data provider, you may not store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

For additional information , see Data providers on the Amazon Location Service Developer Guide.

dataSourceConfiguration

DataSourceConfiguration dataSourceConfiguration

Specifies the data storage option requesting Places.

description

java.lang.String description

The optional description for the place index resource.

Constraints:
Length: 0 - 1000

indexName

java.lang.String indexName

The name of the place index resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique place index resource name.

• No spaces allowed. For example, ExamplePlaceIndex.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

pricingPlan

java.lang.String pricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

tags

java.util.Map<java.lang.String,java.lang.String> tags

Applies one or more tags to the place index resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource.

• Each tag key must be unique and must have exactly one associated value.

• Maximum key length: 128 Unicode characters in UTF-8.

• Maximum value length: 256 Unicode characters in UTF-8.

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @

• Cannot use "aws:" as a prefix for a key.

Class com.amazonaws.services.geo.model.CreatePlaceIndexResult extends java.lang.Object implements Serializable

Serialized Fields

createTime

java.util.Date createTime

The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

indexArn

java.lang.String indexArn

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.

• Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

indexName

java.lang.String indexName

The name for the place index resource.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.CreateRouteCalculatorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

calculatorName

java.lang.String calculatorName

The name of the route calculator resource.

Requirements:

• Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).

• Must be a unique Route calculator resource name.

• No spaces allowed. For example, ExampleRouteCalculator.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

dataSource

java.lang.String dataSource

Specifies the data provider of traffic and road network data.

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error. Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.

Valid values include:

• Esri – For additional information about Esri's coverage in your region of interest, see Esri details on street networks and traffic coverage.

• Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage.

For additional information , see Data providers on the Amazon Location Service Developer Guide.

description

java.lang.String description

The optional description for the route calculator resource.

Constraints:
Length: 0 - 1000

pricingPlan

java.lang.String pricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

tags

java.util.Map<java.lang.String,java.lang.String> tags

Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

• For example: { "tag1" : "value1", "tag2" : "value2"

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

Class com.amazonaws.services.geo.model.CreateRouteCalculatorResult extends java.lang.Object implements Serializable

Serialized Fields

calculatorArn

java.lang.String calculatorArn

The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

calculatorName

java.lang.String calculatorName

The name of the route calculator resource.

• For example, ExampleRouteCalculator.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

createTime

java.util.Date createTime

The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• For example, 2020–07-2T12:15:20.000Z+01:00

Class com.amazonaws.services.geo.model.CreateTrackerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

An optional description for the tracker resource.

Constraints:
Length: 0 - 1000

kmsKeyId

java.lang.String kmsKeyId

A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

Constraints:
Length: 1 - 2048

positionFiltering

java.lang.String positionFiltering

Specifies the position filtering for the tracker resource.

Valid values:

• TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.

• DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.

• AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.

This field is optional. If not specified, the default value is TimeBased.

Constraints:
Allowed Values: TimeBased, DistanceBased, AccuracyBased

pricingPlan

java.lang.String pricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

pricingPlanDataSource

java.lang.String pricingPlanDataSource

This parameter is no longer used.

tags

java.util.Map<java.lang.String,java.lang.String> tags

Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

trackerName

java.lang.String trackerName

The name for the tracker resource.

Requirements:

• Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).

• Must be a unique tracker resource name.

• No spaces allowed. For example, ExampleTracker.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.CreateTrackerResult extends java.lang.Object implements Serializable

Serialized Fields

createTime

java.util.Date createTime

The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

trackerArn

java.lang.String trackerArn

The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

trackerName

java.lang.String trackerName

The name of the tracker resource.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.DataSourceConfiguration extends java.lang.Object implements Serializable

Serialized Fields

intendedUse

java.lang.String intendedUse

Specifies how the results of an operation will be stored by the caller.

Valid values include:

• SingleUse specifies that the results won't be stored.

• Storage specifies that the result can be cached or stored in a database.

Default value: SingleUse

Constraints:
Allowed Values: SingleUse, Storage

Class com.amazonaws.services.geo.model.DeleteGeofenceCollectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionName

java.lang.String collectionName

The name of the geofence collection to be deleted.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.DeleteGeofenceCollectionResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.geo.model.DeleteMapRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

mapName

java.lang.String mapName

The name of the map resource to be deleted.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.DeleteMapResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.geo.model.DeletePlaceIndexRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The name of the place index resource to be deleted.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.DeletePlaceIndexResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.geo.model.DeleteRouteCalculatorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

calculatorName

java.lang.String calculatorName

The name of the route calculator resource to be deleted.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.DeleteRouteCalculatorResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.geo.model.DeleteTrackerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

trackerName

java.lang.String trackerName

The name of the tracker resource to be deleted.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.DeleteTrackerResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.geo.model.DescribeGeofenceCollectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionName

java.lang.String collectionName

The name of the geofence collection.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.DescribeGeofenceCollectionResult extends java.lang.Object implements Serializable

Serialized Fields

collectionArn

java.lang.String collectionArn

The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

collectionName

java.lang.String collectionName

The name of the geofence collection.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

createTime

java.util.Date createTime

The timestamp for when the geofence resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

description

java.lang.String description

The optional description for the geofence collection.

Constraints:
Length: 0 - 1000

kmsKeyId

java.lang.String kmsKeyId

A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource

Constraints:
Length: 1 - 2048

pricingPlan

java.lang.String pricingPlan

No longer used. Always returns RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

pricingPlanDataSource

java.lang.String pricingPlanDataSource

No longer used. Always returns an empty string.

tags

java.util.Map<java.lang.String,java.lang.String> tags

Displays the key, value pairs of tags associated with this resource.

updateTime

java.util.Date updateTime

The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Class com.amazonaws.services.geo.model.DescribeMapRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

mapName

java.lang.String mapName

The name of the map resource.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.DescribeMapResult extends java.lang.Object implements Serializable

Serialized Fields

configuration

MapConfiguration configuration

Specifies the map tile style selected from a partner data provider.

createTime

java.util.Date createTime

The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

dataSource

java.lang.String dataSource

Specifies the data provider for the associated map tiles.

description

java.lang.String description

The optional description for the map resource.

Constraints:
Length: 0 - 1000

mapArn

java.lang.String mapArn

The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:maps/ExampleMap

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

mapName

java.lang.String mapName

The map style selected from an available provider.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

pricingPlan

java.lang.String pricingPlan

No longer used. Always returns RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

tags

java.util.Map<java.lang.String,java.lang.String> tags

Tags associated with the map resource.

updateTime

java.util.Date updateTime

The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Class com.amazonaws.services.geo.model.DescribePlaceIndexRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The name of the place index resource.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.DescribePlaceIndexResult extends java.lang.Object implements Serializable

Serialized Fields

createTime

java.util.Date createTime

The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

dataSource

java.lang.String dataSource

The data provider of geospatial data. Values can be one of the following:

• Esri

• Here

For more information about data providers, see Amazon Location Service data providers.

dataSourceConfiguration

DataSourceConfiguration dataSourceConfiguration

The specified data storage option for requesting Places.

description

java.lang.String description

The optional description for the place index resource.

Constraints:
Length: 0 - 1000

indexArn

java.lang.String indexArn

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across AWS.

• Format example: arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

indexName

java.lang.String indexName

The name of the place index resource being described.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

pricingPlan

java.lang.String pricingPlan

No longer used. Always returns RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

tags

java.util.Map<java.lang.String,java.lang.String> tags

Tags associated with place index resource.

updateTime

java.util.Date updateTime

The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Class com.amazonaws.services.geo.model.DescribeRouteCalculatorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

calculatorName

java.lang.String calculatorName

The name of the route calculator resource.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.DescribeRouteCalculatorResult extends java.lang.Object implements Serializable

Serialized Fields

calculatorArn

java.lang.String calculatorArn

The Amazon Resource Name (ARN) for the Route calculator resource. Use the ARN when you specify a resource across AWS.

• Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

calculatorName

java.lang.String calculatorName

The name of the route calculator resource being described.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

createTime

java.util.Date createTime

The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• For example, 2020–07-2T12:15:20.000Z+01:00

dataSource

java.lang.String dataSource

The data provider of traffic and road network data. Indicates one of the available providers:

• Esri

• Here

For more information about data providers, see Amazon Location Service data providers.

description

java.lang.String description

The optional description of the route calculator resource.

Constraints:
Length: 0 - 1000

pricingPlan

java.lang.String pricingPlan

Always returns RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

tags

java.util.Map<java.lang.String,java.lang.String> tags

Tags associated with route calculator resource.

updateTime

java.util.Date updateTime

The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• For example, 2020–07-2T12:15:20.000Z+01:00

Class com.amazonaws.services.geo.model.DescribeTrackerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

trackerName

java.lang.String trackerName

The name of the tracker resource.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.DescribeTrackerResult extends java.lang.Object implements Serializable

Serialized Fields

createTime

java.util.Date createTime

The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

description

java.lang.String description

The optional description for the tracker resource.

Constraints:
Length: 0 - 1000

kmsKeyId

java.lang.String kmsKeyId

A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.

Constraints:
Length: 1 - 2048

positionFiltering

java.lang.String positionFiltering

The position filtering method of the tracker resource.

Constraints:
Allowed Values: TimeBased, DistanceBased, AccuracyBased

pricingPlan

java.lang.String pricingPlan

Always returns RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

pricingPlanDataSource

java.lang.String pricingPlanDataSource

No longer used. Always returns an empty string.

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags associated with the tracker resource.

trackerArn

java.lang.String trackerArn

The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

trackerName

java.lang.String trackerName

The name of the tracker resource.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

updateTime

java.util.Date updateTime

The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Class com.amazonaws.services.geo.model.DevicePosition extends java.lang.Object implements Serializable

Serialized Fields

accuracy

PositionalAccuracy accuracy

The accuracy of the device position.

deviceId

java.lang.String deviceId

The device whose position you retrieved.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

position

java.util.List<java.lang.Double> position

The last known device position.

positionProperties

java.util.Map<java.lang.String,java.lang.String> positionProperties

The properties associated with the position.

receivedTime

java.util.Date receivedTime

The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

sampleTime

java.util.Date sampleTime

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Class com.amazonaws.services.geo.model.DevicePositionUpdate extends java.lang.Object implements Serializable

Serialized Fields

accuracy

PositionalAccuracy accuracy

The accuracy of the device position.

deviceId

java.lang.String deviceId

The device associated to the position update.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

position

java.util.List<java.lang.Double> position

The latest device position defined in WGS 84 format: [X or longitude, Y or latitude].

positionProperties

java.util.Map<java.lang.String,java.lang.String> positionProperties

Associates one of more properties with the position update. A property is a key-value pair stored with the position update and added to any geofence event the update may trigger.

Format: "key" : "value"

sampleTime

java.util.Date sampleTime

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Class com.amazonaws.services.geo.model.DisassociateTrackerConsumerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

consumerArn

java.lang.String consumerArn

The Amazon Resource Name (ARN) for the geofence collection to be disassociated from the tracker resource. Used when you need to specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

trackerName

java.lang.String trackerName

The name of the tracker resource to be dissociated from the consumer.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.DisassociateTrackerConsumerResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.geo.model.GeofenceGeometry extends java.lang.Object implements Serializable

Serialized Fields

circle

Circle circle

A circle on the earth, as defined by a center point and a radius.

polygon

java.util.List<java.util.List<java.util.List<java.lang.Double>>> polygon

An array of 1 or more linear rings. A linear ring is an array of 4 or more vertices, where the first and last vertex are the same to form a closed boundary. Each vertex is a 2-dimensional point of the form: [longitude, latitude].

The first linear ring is an outer ring, describing the polygon's boundary. Subsequent linear rings may be inner or outer rings to describe holes and islands. Outer rings must list their vertices in counter-clockwise order around the ring's center, where the left side is the polygon's exterior. Inner rings must list their vertices in clockwise order, where the left side is the polygon's interior.

A geofence polygon can consist of between 4 and 1,000 vertices.

Class com.amazonaws.services.geo.model.GetDevicePositionHistoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deviceId

java.lang.String deviceId

The device whose position history you want to retrieve.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

endTimeExclusive

java.util.Date endTimeExclusive

Specify the end time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the time that the request is made.

Requirement:

• The time specified for EndTimeExclusive must be after the time for StartTimeInclusive.

maxResults

java.lang.Integer maxResults

An optional limit for the number of device positions returned in a single call.

Default value: 100

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

Constraints:
Length: 1 - 2000

startTimeInclusive

java.util.Date startTimeInclusive

Specify the start time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24 hours prior to the time that the request is made.

Requirement:

• The time specified for StartTimeInclusive must be before EndTimeExclusive.

trackerName

java.lang.String trackerName

The tracker resource receiving the request for the device position history.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.GetDevicePositionHistoryResult extends java.lang.Object implements Serializable

Serialized Fields

devicePositions

java.util.List<DevicePosition> devicePositions

Contains the position history details for the requested device.

nextToken

java.lang.String nextToken

A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

Constraints:
Length: 1 - 2000

Class com.amazonaws.services.geo.model.GetDevicePositionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deviceId

java.lang.String deviceId

The device whose position you want to retrieve.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

trackerName

java.lang.String trackerName

The tracker resource receiving the position update.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.GetDevicePositionResult extends java.lang.Object implements Serializable

Serialized Fields

accuracy

PositionalAccuracy accuracy

The accuracy of the device position.

deviceId

java.lang.String deviceId

The device whose position you retrieved.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

position

java.util.List<java.lang.Double> position

The last known device position.

positionProperties

java.util.Map<java.lang.String,java.lang.String> positionProperties

The properties associated with the position.

receivedTime

java.util.Date receivedTime

The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

sampleTime

java.util.Date sampleTime

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Class com.amazonaws.services.geo.model.GetGeofenceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionName

java.lang.String collectionName

The geofence collection storing the target geofence.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

geofenceId

java.lang.String geofenceId

The geofence you're retrieving details for.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

Class com.amazonaws.services.geo.model.GetGeofenceResult extends java.lang.Object implements Serializable

Serialized Fields

createTime

java.util.Date createTime

The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

geofenceId

java.lang.String geofenceId

The geofence identifier.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

geometry

GeofenceGeometry geometry

Contains the geofence geometry details describing a polygon or a circle.

status

java.lang.String status

Identifies the state of the geofence. A geofence will hold one of the following states:

• ACTIVE — The geofence has been indexed by the system.

• PENDING — The geofence is being processed by the system.

• FAILED — The geofence failed to be indexed by the system.

• DELETED — The geofence has been deleted from the system index.

• DELETING — The geofence is being deleted from the system index.

updateTime

java.util.Date updateTime

The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Class com.amazonaws.services.geo.model.GetMapGlyphsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

fontStack

java.lang.String fontStack

A comma-separated list of fonts to load glyphs from in order of preference. For example, Noto Sans Regular, Arial Unicode.

Valid fonts stacks for Esri styles:

• VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu Medium | Ubuntu Italic | Ubuntu Regular | Ubuntu Bold

• VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu Regular | Ubuntu Light | Ubuntu Bold

• VectorEsriTopographic – Noto Sans Italic | Noto Sans Regular | Noto Sans Bold | Noto Serif Regular | Roboto Condensed Light Italic

• VectorEsriStreets – Arial Regular | Arial Italic | Arial Bold

• VectorEsriNavigation – Arial Regular | Arial Italic | Arial Bold

Valid font stacks for HERE Technologies styles:

• VectorHereContrast – Fira GO Regular | Fira GO Bold

• VectorHereExplore, VectorHereExploreTruck – Firo GO Italic | Fira GO Map | Fira GO Map Bold | Noto Sans CJK JP Bold | Noto Sans CJK JP Light | Noto Sans CJK JP Regular

fontUnicodeRange

java.lang.String fontUnicodeRange

A Unicode range of characters to download glyphs for. Each response will contain 256 characters. For example, 0–255 includes all characters from range U+0000 to 00FF. Must be aligned to multiples of 256.

Constraints:
Pattern: ^[0-9]+-[0-9]+\.pbf$

mapName

java.lang.String mapName

The map resource associated with the glyph file.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.GetMapGlyphsResult extends java.lang.Object implements Serializable

Serialized Fields

blob

java.nio.ByteBuffer blob

The blob's content type.

contentType

java.lang.String contentType

The map glyph content type. For example, application/octet-stream.

Class com.amazonaws.services.geo.model.GetMapSpritesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

fileName

java.lang.String fileName

The name of the sprite file. Use the following file names for the sprite sheet:

• sprites.png

• sprites@2x.png for high pixel density displays

For the JSON document contain image offsets. Use the following file names:

• sprites.json

• sprites@2x.json for high pixel density displays

Constraints:
Pattern: ^sprites(@2x)?\.(png|json)$

mapName

java.lang.String mapName

The map resource associated with the sprite file.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.GetMapSpritesResult extends java.lang.Object implements Serializable

Serialized Fields

blob

java.nio.ByteBuffer blob

Contains the body of the sprite sheet or JSON offset file.

contentType

java.lang.String contentType

The content type of the sprite sheet and offsets. For example, the sprite sheet content type is image/png, and the sprite offset JSON document is application/json.

Class com.amazonaws.services.geo.model.GetMapStyleDescriptorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

mapName

java.lang.String mapName

The map resource to retrieve the style descriptor from.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.GetMapStyleDescriptorResult extends java.lang.Object implements Serializable

Serialized Fields

blob

java.nio.ByteBuffer blob

Contains the body of the style descriptor.

contentType

java.lang.String contentType

The style descriptor's content type. For example, application/json.

Class com.amazonaws.services.geo.model.GetMapTileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

mapName

java.lang.String mapName

The map resource to retrieve the map tiles from.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

x

java.lang.String x

The X axis value for the map tile.

Constraints:
Pattern: \d+

y

java.lang.String y

The Y axis value for the map tile.

Constraints:
Pattern: \d+

z

java.lang.String z

The zoom value for the map tile.

Constraints:
Pattern: \d+

Class com.amazonaws.services.geo.model.GetMapTileResult extends java.lang.Object implements Serializable

Serialized Fields

blob

java.nio.ByteBuffer blob

Contains Mapbox Vector Tile (MVT) data.

contentType

java.lang.String contentType

The map tile's content type. For example, application/vnd.mapbox-vector-tile.

Class com.amazonaws.services.geo.model.InternalServerException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.geo.model.Leg extends java.lang.Object implements Serializable

Serialized Fields

distance

java.lang.Double distance

The distance between the leg's StartPosition and EndPosition along a calculated route.

• The default measurement is Kilometers unless the request specifies a DistanceUnit of Miles.

Constraints:
Range: 0.0 -

durationSeconds

java.lang.Double durationSeconds

The estimated travel time between the leg's StartPosition and EndPosition. The travel mode and departure time that you specify in the request determines the calculated time.

Constraints:
Range: 0.0 -

endPosition

java.util.List<java.lang.Double> endPosition

The terminating position of the leg. Follows the format [longitude,latitude].

If the EndPosition isn't located on a road, it's snapped to a nearby road.

geometry

LegGeometry geometry

Contains the calculated route's path as a linestring geometry.

startPosition

java.util.List<java.lang.Double> startPosition

The starting position of the leg. Follows the format [longitude,latitude].

If the StartPosition isn't located on a road, it's snapped to a nearby road.

steps

java.util.List<Step> steps

Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.

Class com.amazonaws.services.geo.model.LegGeometry extends java.lang.Object implements Serializable

Serialized Fields

lineString

java.util.List<java.util.List<java.lang.Double>> lineString

An ordered list of positions used to plot a route on a map.

The first position is closest to the start position for the leg, and the last position is the closest to the end position for the leg.

• For example, [[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]

Class com.amazonaws.services.geo.model.ListDevicePositionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

An optional limit for the number of entries returned in a single call.

Default value: 100

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

Constraints:
Length: 1 - 2000

trackerName

java.lang.String trackerName

The tracker resource containing the requested devices.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.ListDevicePositionsResponseEntry extends java.lang.Object implements Serializable

Serialized Fields

accuracy

PositionalAccuracy accuracy

The accuracy of the device position.

deviceId

java.lang.String deviceId

The ID of the device for this position.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

position

java.util.List<java.lang.Double> position

The last known device position. Empty if no positions currently stored.

positionProperties

java.util.Map<java.lang.String,java.lang.String> positionProperties

The properties associated with the position.

sampleTime

java.util.Date sampleTime

The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Class com.amazonaws.services.geo.model.ListDevicePositionsResult extends java.lang.Object implements Serializable

Serialized Fields

entries

java.util.List<ListDevicePositionsResponseEntry> entries

Contains details about each device's last known position. These details includes the device ID, the time when the position was sampled on the device, the time that the service received the update, and the most recent coordinates.

nextToken

java.lang.String nextToken

A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

Constraints:
Length: 1 - 2000

Class com.amazonaws.services.geo.model.ListGeofenceCollectionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

An optional limit for the number of resources returned in a single call.

Default value: 100

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

Constraints:
Length: 1 - 2000

Class com.amazonaws.services.geo.model.ListGeofenceCollectionsResponseEntry extends java.lang.Object implements Serializable

Serialized Fields

collectionName

java.lang.String collectionName

The name of the geofence collection.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

createTime

java.util.Date createTime

The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

description

java.lang.String description

The description for the geofence collection

Constraints:
Length: 0 - 1000

pricingPlan

java.lang.String pricingPlan

No longer used. Always returns RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

pricingPlanDataSource

java.lang.String pricingPlanDataSource

No longer used. Always returns an empty string.

updateTime

java.util.Date updateTime

Specifies a timestamp for when the resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Class com.amazonaws.services.geo.model.ListGeofenceCollectionsResult extends java.lang.Object implements Serializable

Serialized Fields

entries

java.util.List<ListGeofenceCollectionsResponseEntry> entries

Lists the geofence collections that exist in your AWS account.

nextToken

java.lang.String nextToken

A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

Constraints:
Length: 1 - 2000

Class com.amazonaws.services.geo.model.ListGeofenceResponseEntry extends java.lang.Object implements Serializable

Serialized Fields

createTime

java.util.Date createTime

The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

geofenceId

java.lang.String geofenceId

The geofence identifier.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

geometry

GeofenceGeometry geometry

Contains the geofence geometry details describing a polygon or a circle.

status

java.lang.String status

Identifies the state of the geofence. A geofence will hold one of the following states:

• ACTIVE — The geofence has been indexed by the system.

• PENDING — The geofence is being processed by the system.

• FAILED — The geofence failed to be indexed by the system.

• DELETED — The geofence has been deleted from the system index.

• DELETING — The geofence is being deleted from the system index.

updateTime

java.util.Date updateTime

The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Class com.amazonaws.services.geo.model.ListGeofencesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionName

java.lang.String collectionName

The name of the geofence collection storing the list of geofences.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

maxResults

java.lang.Integer maxResults

An optional limit for the number of geofences returned in a single call.

Default value: 100

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

Constraints:
Length: 1 - 2000

Class com.amazonaws.services.geo.model.ListGeofencesResult extends java.lang.Object implements Serializable

Serialized Fields

entries

java.util.List<ListGeofenceResponseEntry> entries

Contains a list of geofences stored in the geofence collection.

nextToken

java.lang.String nextToken

A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

Constraints:
Length: 1 - 2000

Class com.amazonaws.services.geo.model.ListMapsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

An optional limit for the number of resources returned in a single call.

Default value: 100

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

Constraints:
Length: 1 - 2000

Class com.amazonaws.services.geo.model.ListMapsResponseEntry extends java.lang.Object implements Serializable

Serialized Fields

createTime

java.util.Date createTime

The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

dataSource

java.lang.String dataSource

Specifies the data provider for the associated map tiles.

description

java.lang.String description

The description for the map resource.

Constraints:
Length: 0 - 1000

mapName

java.lang.String mapName

The name of the associated map resource.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

pricingPlan

java.lang.String pricingPlan

No longer used. Always returns RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

updateTime

java.util.Date updateTime

The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Class com.amazonaws.services.geo.model.ListMapsResult extends java.lang.Object implements Serializable

Serialized Fields

entries

java.util.List<ListMapsResponseEntry> entries

Contains a list of maps in your AWS account

nextToken

java.lang.String nextToken

A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

Constraints:
Length: 1 - 2000

Class com.amazonaws.services.geo.model.ListPlaceIndexesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

An optional limit for the maximum number of results returned in a single call.

Default value: 100

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

Constraints:
Length: 1 - 2000

Class com.amazonaws.services.geo.model.ListPlaceIndexesResponseEntry extends java.lang.Object implements Serializable

Serialized Fields

createTime

java.util.Date createTime

The timestamp for when the place index resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

dataSource

java.lang.String dataSource

The data provider of geospatial data. Values can be one of the following:

• Esri

• Here

For more information about data providers, see Amazon Location Service data providers.

description

java.lang.String description

The optional description for the place index resource.

Constraints:
Length: 0 - 1000

indexName

java.lang.String indexName

The name of the place index resource.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

pricingPlan

java.lang.String pricingPlan

No longer used. Always returns RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

updateTime

java.util.Date updateTime

The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Class com.amazonaws.services.geo.model.ListPlaceIndexesResult extends java.lang.Object implements Serializable

Serialized Fields

entries

java.util.List<ListPlaceIndexesResponseEntry> entries

Lists the place index resources that exist in your AWS account

nextToken

java.lang.String nextToken

A pagination token indicating that there are additional pages available. You can use the token in a new request to fetch the next page of results.

Constraints:
Length: 1 - 2000

Class com.amazonaws.services.geo.model.ListRouteCalculatorsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

An optional maximum number of results returned in a single call.

Default Value: 100

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default Value: null

Constraints:
Length: 1 - 2000

Class com.amazonaws.services.geo.model.ListRouteCalculatorsResponseEntry extends java.lang.Object implements Serializable

Serialized Fields

calculatorName

java.lang.String calculatorName

The name of the route calculator resource.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

createTime

java.util.Date createTime

The timestamp when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• For example, 2020–07-2T12:15:20.000Z+01:00

dataSource

java.lang.String dataSource

The data provider of traffic and road network data. Indicates one of the available providers:

• Esri

• Here

For more information about data providers, see Amazon Location Service data providers.

description

java.lang.String description

The optional description of the route calculator resource.

Constraints:
Length: 0 - 1000

pricingPlan

java.lang.String pricingPlan

Always returns RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

updateTime

java.util.Date updateTime

The timestamp when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• For example, 2020–07-2T12:15:20.000Z+01:00

Class com.amazonaws.services.geo.model.ListRouteCalculatorsResult extends java.lang.Object implements Serializable

Serialized Fields

entries

java.util.List<ListRouteCalculatorsResponseEntry> entries

Lists the route calculator resources that exist in your AWS account

nextToken

java.lang.String nextToken

A pagination token indicating there are additional pages available. You can use the token in a subsequent request to fetch the next set of results.

Constraints:
Length: 1 - 2000

Class com.amazonaws.services.geo.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

• Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

Class com.amazonaws.services.geo.model.ListTagsForResourceResult extends java.lang.Object implements Serializable

Serialized Fields

tags

java.util.Map<java.lang.String,java.lang.String> tags

Tags that have been applied to the specified resource. Tags are mapped from the tag key to the tag value: "TagKey" : "TagValue".

• Format example: {"tag1" : "value1", "tag2" : "value2"}

Class com.amazonaws.services.geo.model.ListTrackerConsumersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

An optional limit for the number of resources returned in a single call.

Default value: 100

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

Constraints:
Length: 1 - 2000

trackerName

java.lang.String trackerName

The tracker resource whose associated geofence collections you want to list.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.ListTrackerConsumersResult extends java.lang.Object implements Serializable

Serialized Fields

consumerArns

java.util.List<java.lang.String> consumerArns

Contains the list of geofence collection ARNs associated to the tracker resource.

nextToken

java.lang.String nextToken

A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

Constraints:
Length: 1 - 2000

Class com.amazonaws.services.geo.model.ListTrackersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

An optional limit for the number of resources returned in a single call.

Default value: 100

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

Constraints:
Length: 1 - 2000

Class com.amazonaws.services.geo.model.ListTrackersResponseEntry extends java.lang.Object implements Serializable

Serialized Fields

createTime

java.util.Date createTime

The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

description

java.lang.String description

The description for the tracker resource.

Constraints:
Length: 0 - 1000

pricingPlan

java.lang.String pricingPlan

Always returns RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

pricingPlanDataSource

java.lang.String pricingPlanDataSource

No longer used. Always returns an empty string.

trackerName

java.lang.String trackerName

The name of the tracker resource.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

updateTime

java.util.Date updateTime

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Class com.amazonaws.services.geo.model.ListTrackersResult extends java.lang.Object implements Serializable

Serialized Fields

entries

java.util.List<ListTrackersResponseEntry> entries

Contains tracker resources in your AWS account. Details include tracker name, description and timestamps for when the tracker was created and last updated.

nextToken

java.lang.String nextToken

A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

Constraints:
Length: 1 - 2000

Class com.amazonaws.services.geo.model.MapConfiguration extends java.lang.Object implements Serializable

Serialized Fields

style

java.lang.String style

Specifies the map style selected from an available data provider.

Valid Esri map styles:

• VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content.

• RasterEsriImagery – The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide.

• VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content.

• VectorEsriTopographic – The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.

• VectorEsriStreets – The Esri World Streets map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.

• VectorEsriNavigation – The Esri World Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices.

Valid HERE Technologies map styles:

• VectorHereContrast – The HERE Contrast (Berlin) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.

• VectorHereExplore – A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features. It also now includes a fully designed map of Japan.

• VectorHereExploreTruck – A global map containing truck restrictions and attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics.

The VectorHereContrast style has been renamed from VectorHereBerlin. VectorHereBerlin has been deprecated, but will continue to work in applications that use it.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.Place extends java.lang.Object implements Serializable

Serialized Fields

addressNumber

java.lang.String addressNumber

The numerical portion of an address, such as a building number.

country

java.lang.String country

A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.

geometry

PlaceGeometry geometry

Places uses a point geometry to specify a location or a Place.

interpolated

java.lang.Boolean interpolated

True if the result is interpolated from other known places.

False if the Place is a known place.

Not returned when the partner does not provide the information.

For example, returns False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.

label

java.lang.String label

The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA.

municipality

java.lang.String municipality

A name for a local area, such as a city or town name. For example, Toronto.

neighborhood

java.lang.String neighborhood

The name of a community district. For example, Downtown.

postalCode

java.lang.String postalCode

A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.

region

java.lang.String region

A name for an area or geographical division, such as a province or state name. For example, British Columbia.

street

java.lang.String street

The name for a street or a road to identify a location. For example, Main Street.

subRegion

java.lang.String subRegion

A country, or an area that's part of a larger region. For example, Metro Vancouver.

timeZone

TimeZone timeZone

The time zone in which the Place is located. Returned only when using Here as the selected partner.

Class com.amazonaws.services.geo.model.PlaceGeometry extends java.lang.Object implements Serializable

Serialized Fields

point

java.util.List<java.lang.Double> point

A single point geometry specifies a location for a Place using WGS 84 coordinates:

• x — Specifies the x coordinate or longitude.

• y — Specifies the y coordinate or latitude.

Class com.amazonaws.services.geo.model.PositionalAccuracy extends java.lang.Object implements Serializable

Serialized Fields

horizontal

java.lang.Double horizontal

Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.

Constraints:
Range: 0.0 - 10000.0

Class com.amazonaws.services.geo.model.PutGeofenceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionName

java.lang.String collectionName

The geofence collection to store the geofence in.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

geofenceId

java.lang.String geofenceId

An identifier for the geofence. For example, ExampleGeofence-1.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

geometry

GeofenceGeometry geometry

Contains the details to specify the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.

Each geofence polygon can have a maximum of 1,000 vertices.

Class com.amazonaws.services.geo.model.PutGeofenceResult extends java.lang.Object implements Serializable

Serialized Fields

createTime

java.util.Date createTime

The timestamp for when the geofence was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

geofenceId

java.lang.String geofenceId

The geofence identifier entered in the request.

Constraints:
Length: 1 - 100
Pattern: ^[-._\p{L}\p{N}]+$

updateTime

java.util.Date updateTime

The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Class com.amazonaws.services.geo.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.geo.model.RouteMatrixEntry extends java.lang.Object implements Serializable

Serialized Fields

distance

java.lang.Double distance

The total distance of travel for the route.

Constraints:
Range: 0.0 -

durationSeconds

java.lang.Double durationSeconds

The expected duration of travel for the route.

Constraints:
Range: 0.0 -

error

RouteMatrixEntryError error

An error corresponding to the calculation of a route between the DeparturePosition and DestinationPosition.

Class com.amazonaws.services.geo.model.RouteMatrixEntryError extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.String code

The type of error which occurred for the route calculation.

Constraints:
Allowed Values: RouteNotFound, RouteTooLong, PositionsNotFound, DestinationPositionNotFound, DeparturePositionNotFound, OtherValidationError

message

java.lang.String message

A message about the error that occurred for the route calculation.

Class com.amazonaws.services.geo.model.SearchForPositionResult extends java.lang.Object implements Serializable

Serialized Fields

distance

java.lang.Double distance

The distance in meters of a great-circle arc between the query position and the result.

A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.

Constraints:
Range: 0.0 -

place

Place place

Details about the search result, such as its address and position.

Class com.amazonaws.services.geo.model.SearchForSuggestionsResult extends java.lang.Object implements Serializable

Serialized Fields

text

java.lang.String text

The text of the place suggestion, typically formatted as an address string.

Class com.amazonaws.services.geo.model.SearchForTextResult extends java.lang.Object implements Serializable

Serialized Fields

distance

java.lang.Double distance

The distance in meters of a great-circle arc between the bias position specified and the result. Distance will be returned only if a bias position was specified in the query.

A great-circle arc is the shortest path on a sphere, in this case the Earth. This returns the shortest distance between two locations.

Constraints:
Range: 0.0 -

place

Place place

Details about the search result, such as its address and position.

relevance

java.lang.Double relevance

The relative confidence in the match for a result among the results returned. For example, if more fields for an address match (including house number, street, city, country/region, and postal code), the relevance score is closer to 1.

Returned only when the partner selected is Esri.

Constraints:
Range: 0.0 - 1.0

Class com.amazonaws.services.geo.model.SearchPlaceIndexForPositionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The name of the place index resource you want to use for the search.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

language

java.lang.String language

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

Constraints:
Length: 2 - 35

maxResults

java.lang.Integer maxResults

An optional parameter. The maximum number of results returned per request.

Default value: 50

Constraints:
Range: 1 - 50

position

java.util.List<java.lang.Double> position

Specifies the longitude and latitude of the position to query.

This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents a position with longitude -123.1174 and latitude 49.2847.

Class com.amazonaws.services.geo.model.SearchPlaceIndexForPositionResult extends java.lang.Object implements Serializable

Serialized Fields

results

java.util.List<SearchForPositionResult> results

Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned.

summary

SearchPlaceIndexForPositionSummary summary

Contains a summary of the request. Echoes the input values for Position, Language, MaxResults, and the DataSource of the place index.

Class com.amazonaws.services.geo.model.SearchPlaceIndexForPositionSummary extends java.lang.Object implements Serializable

Serialized Fields

dataSource

java.lang.String dataSource

The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

• Esri

• Here

For more information about data providers, see Amazon Location Service data providers.

language

java.lang.String language

The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

Constraints:
Length: 2 - 35

maxResults

java.lang.Integer maxResults

Contains the optional result count limit that is specified in the request.

Default value: 50

Constraints:
Range: 1 - 50

position

java.util.List<java.lang.Double> position

The position specified in the request.

Class com.amazonaws.services.geo.model.SearchPlaceIndexForSuggestionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

biasPosition

java.util.List<java.lang.Double> biasPosition

An optional parameter that indicates a preference for place suggestions that are closer to a specified position.

If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

filterBBox

java.util.List<java.lang.Double> filterBBox

An optional parameter that limits the search results by returning only suggestions within a specified bounding box.

If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

filterCountries

java.util.List<java.lang.String> filterCountries

An optional parameter that limits the search results by returning only suggestions within the provided list of countries.

• Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters: AUS.

indexName

java.lang.String indexName

The name of the place index resource you want to use for the search.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

language

java.lang.String language

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for Athens, Gr to get suggestions with the language parameter set to en. The results found will most likely be returned as Athens, Greece.

If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα, Ελλάδα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

Constraints:
Length: 2 - 35

maxResults

java.lang.Integer maxResults

An optional parameter. The maximum number of results returned per request.

The default: 5

Constraints:
Range: 1 - 15

text

java.lang.String text

The free-form partial text to use to generate place suggestions. For example, eiffel tow.

Constraints:
Length: 1 - 200

Class com.amazonaws.services.geo.model.SearchPlaceIndexForSuggestionsResult extends java.lang.Object implements Serializable

Serialized Fields

results

java.util.List<SearchForSuggestionsResult> results

A list of place suggestions that best match the search text.

summary

SearchPlaceIndexForSuggestionsSummary summary

Contains a summary of the request. Echoes the input values for BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index.

Class com.amazonaws.services.geo.model.SearchPlaceIndexForSuggestionsSummary extends java.lang.Object implements Serializable

Serialized Fields

biasPosition

java.util.List<java.lang.Double> biasPosition

Contains the coordinates for the optional bias position specified in the request.

This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

dataSource

java.lang.String dataSource

The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

• Esri

• Here

For more information about data providers, see Amazon Location Service data providers.

filterBBox

java.util.List<java.lang.Double> filterBBox

Contains the coordinates for the optional bounding box specified in the request.

filterCountries

java.util.List<java.lang.String> filterCountries

Contains the optional country filter specified in the request.

language

java.lang.String language

The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

Constraints:
Length: 2 - 35

maxResults

java.lang.Integer maxResults

Contains the optional result count limit specified in the request.

text

java.lang.String text

The free-form partial text input specified in the request.

Class com.amazonaws.services.geo.model.SearchPlaceIndexForTextRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

biasPosition

java.util.List<java.lang.Double> biasPosition

An optional parameter that indicates a preference for places that are closer to a specified position.

If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

filterBBox

java.util.List<java.lang.Double> filterBBox

An optional parameter that limits the search results by returning only places that are within the provided bounding box.

If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

filterCountries

java.util.List<java.lang.String> filterCountries

An optional parameter that limits the search results by returning only places that are in a specified list of countries.

• Valid values include ISO 3166 3-digit country codes. For example, Australia uses three upper-case characters: AUS.

indexName

java.lang.String indexName

The name of the place index resource you want to use for the search.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

language

java.lang.String language

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for Athens, Greece, with the language parameter set to en. The result found will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the result found will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

Constraints:
Length: 2 - 35

maxResults

java.lang.Integer maxResults

An optional parameter. The maximum number of results returned per request.

The default: 50

Constraints:
Range: 1 - 50

text

java.lang.String text

The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street.

Constraints:
Length: 1 - 200

Class com.amazonaws.services.geo.model.SearchPlaceIndexForTextResult extends java.lang.Object implements Serializable

Serialized Fields

results

java.util.List<SearchForTextResult> results

A list of Places matching the input text. Each result contains additional information about the specific point of interest.

Not all response properties are included with all responses. Some properties may only be returned by specific data partners.

summary

SearchPlaceIndexForTextSummary summary

Contains a summary of the request. Echoes the input values for BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index and the bounding box, ResultBBox, which surrounds the search results.

Class com.amazonaws.services.geo.model.SearchPlaceIndexForTextSummary extends java.lang.Object implements Serializable

Serialized Fields

biasPosition

java.util.List<java.lang.Double> biasPosition

Contains the coordinates for the optional bias position specified in the request.

This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

dataSource

java.lang.String dataSource

The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

• Esri

• Here

For more information about data providers, see Amazon Location Service data providers.

filterBBox

java.util.List<java.lang.Double> filterBBox

Contains the coordinates for the optional bounding box specified in the request.

filterCountries

java.util.List<java.lang.String> filterCountries

Contains the optional country filter specified in the request.

language

java.lang.String language

The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

Constraints:
Length: 2 - 35

maxResults

java.lang.Integer maxResults

Contains the optional result count limit specified in the request.

Constraints:
Range: 1 - 50

resultBBox

java.util.List<java.lang.Double> resultBBox

The bounding box that fully contains all search results.

If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.

text

java.lang.String text

The search text specified in the request.

Class com.amazonaws.services.geo.model.ServiceQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.geo.model.Step extends java.lang.Object implements Serializable

Serialized Fields

distance

java.lang.Double distance

The travel distance between the step's StartPosition and EndPosition.

Constraints:
Range: 0.0 -

durationSeconds

java.lang.Double durationSeconds

The estimated travel time, in seconds, from the step's StartPosition to the EndPosition. . The travel mode and departure time that you specify in the request determines the calculated time.

Constraints:
Range: 0.0 -

endPosition

java.util.List<java.lang.Double> endPosition

The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.

geometryOffset

java.lang.Integer geometryOffset

Represents the start position, or index, in a sequence of steps within the leg's line string geometry. For example, the index of the first step in a leg geometry is 0.

Included in the response for queries that set IncludeLegGeometry to True.

Constraints:
Range: 0 -

startPosition

java.util.List<java.lang.Double> startPosition

The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg.

Class com.amazonaws.services.geo.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the resource whose tags you want to update.

• Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

tags

java.util.Map<java.lang.String,java.lang.String> tags

Applies one or more tags to specific resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource.

• Each tag key must be unique and must have exactly one associated value.

• Maximum key length: 128 Unicode characters in UTF-8.

• Maximum value length: 256 Unicode characters in UTF-8.

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @

• Cannot use "aws:" as a prefix for a key.

Class com.amazonaws.services.geo.model.TagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.geo.model.ThrottlingException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.geo.model.TimeZone extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the time zone, following the IANA time zone standard. For example, America/Los_Angeles.

offset

java.lang.Integer offset

The time zone's offset, in seconds, from UTC.

Class com.amazonaws.services.geo.model.TruckDimensions extends java.lang.Object implements Serializable

Serialized Fields

height

java.lang.Double height

The height of the truck.

• For example, 4.5.

For routes calculated with a HERE resource, this value must be between 0 and 50 meters.

Constraints:
Range: 0.0 -

length

java.lang.Double length

The length of the truck.

• For example, 15.5.

For routes calculated with a HERE resource, this value must be between 0 and 300 meters.

Constraints:
Range: 0.0 -

unit

java.lang.String unit

Specifies the unit of measurement for the truck dimensions.

Default Value: Meters

Constraints:
Allowed Values: Meters, Feet

width

java.lang.Double width

The width of the truck.

• For example, 4.5.

For routes calculated with a HERE resource, this value must be between 0 and 50 meters.

Constraints:
Range: 0.0 -

Class com.amazonaws.services.geo.model.TruckWeight extends java.lang.Object implements Serializable

Serialized Fields

total

java.lang.Double total

The total weight of the truck.

• For example, 3500.

Constraints:
Range: 0.0 -

unit

java.lang.String unit

The unit of measurement to use for the truck weight.

Default Value: Kilograms

Constraints:
Allowed Values: Kilograms, Pounds

Class com.amazonaws.services.geo.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the resource from which you want to remove tags.

• Format example: arn:aws:geo:region:account-id:resourcetype/ExampleResource

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

tagKeys

java.util.List<java.lang.String> tagKeys

The list of tag keys to remove from the specified resource.

Class com.amazonaws.services.geo.model.UntagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.geo.model.UpdateGeofenceCollectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionName

java.lang.String collectionName

The name of the geofence collection to update.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

description

java.lang.String description

Updates the description for the geofence collection.

Constraints:
Length: 0 - 1000

pricingPlan

java.lang.String pricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

pricingPlanDataSource

java.lang.String pricingPlanDataSource

This parameter is no longer used.

Class com.amazonaws.services.geo.model.UpdateGeofenceCollectionResult extends java.lang.Object implements Serializable

Serialized Fields

collectionArn

java.lang.String collectionArn

The Amazon Resource Name (ARN) of the updated geofence collection. Used to specify a resource across AWS.

• Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

collectionName

java.lang.String collectionName

The name of the updated geofence collection.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

updateTime

java.util.Date updateTime

The time when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Class com.amazonaws.services.geo.model.UpdateMapRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

Updates the description for the map resource.

Constraints:
Length: 0 - 1000

mapName

java.lang.String mapName

The name of the map resource to update.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

pricingPlan

java.lang.String pricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

Class com.amazonaws.services.geo.model.UpdateMapResult extends java.lang.Object implements Serializable

Serialized Fields

mapArn

java.lang.String mapArn

The Amazon Resource Name (ARN) of the updated map resource. Used to specify a resource across AWS.

• Format example: arn:aws:geo:region:account-id:maps/ExampleMap

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

mapName

java.lang.String mapName

The name of the updated map resource.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

updateTime

java.util.Date updateTime

The timestamp for when the map resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Class com.amazonaws.services.geo.model.UpdatePlaceIndexRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dataSourceConfiguration

DataSourceConfiguration dataSourceConfiguration

Updates the data storage option for the place index resource.

description

java.lang.String description

Updates the description for the place index resource.

Constraints:
Length: 0 - 1000

indexName

java.lang.String indexName

The name of the place index resource to update.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

pricingPlan

java.lang.String pricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

Class com.amazonaws.services.geo.model.UpdatePlaceIndexResult extends java.lang.Object implements Serializable

Serialized Fields

indexArn

java.lang.String indexArn

The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a resource across AWS.

• Format example: arn:aws:geo:region:account-id:place- index/ExamplePlaceIndex

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

indexName

java.lang.String indexName

The name of the updated place index resource.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

updateTime

java.util.Date updateTime

The timestamp for when the place index resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Class com.amazonaws.services.geo.model.UpdateRouteCalculatorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

calculatorName

java.lang.String calculatorName

The name of the route calculator resource to update.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

description

java.lang.String description

Updates the description for the route calculator resource.

Constraints:
Length: 0 - 1000

pricingPlan

java.lang.String pricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

Class com.amazonaws.services.geo.model.UpdateRouteCalculatorResult extends java.lang.Object implements Serializable

Serialized Fields

calculatorArn

java.lang.String calculatorArn

The Amazon Resource Name (ARN) of the updated route calculator resource. Used to specify a resource across AWS.

• Format example: arn:aws:geo:region:account-id:route- calculator/ExampleCalculator

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

calculatorName

java.lang.String calculatorName

The name of the updated route calculator resource.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

updateTime

java.util.Date updateTime

The timestamp for when the route calculator was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Class com.amazonaws.services.geo.model.UpdateTrackerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

Updates the description for the tracker resource.

Constraints:
Length: 0 - 1000

positionFiltering

java.lang.String positionFiltering

Updates the position filtering for the tracker resource.

Valid values:

• TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.

• DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.

• AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.

Constraints:
Allowed Values: TimeBased, DistanceBased, AccuracyBased

pricingPlan

java.lang.String pricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage.

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

pricingPlanDataSource

java.lang.String pricingPlanDataSource

This parameter is no longer used.

trackerName

java.lang.String trackerName

The name of the tracker resource to update.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Class com.amazonaws.services.geo.model.UpdateTrackerResult extends java.lang.Object implements Serializable

Serialized Fields

trackerArn

java.lang.String trackerArn

The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS.

• Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

Constraints:
Length: 0 - 1600
Pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0- 9]+)*)?){2}:([^/].*)?$

trackerName

java.lang.String trackerName

The name of the updated tracker resource.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

updateTime

java.util.Date updateTime

The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Class com.amazonaws.services.geo.model.ValidationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

fieldList

java.util.List<ValidationExceptionField> fieldList

The field where the invalid entry was detected.

reason

java.lang.String reason

A message with the reason for the validation exception error.

Constraints:
Allowed Values: UnknownOperation, Missing, CannotParse, FieldValidationFailed, Other

Class com.amazonaws.services.geo.model.ValidationExceptionField extends java.lang.Object implements Serializable

Serialized Fields

message

java.lang.String message

A message with the reason for the validation exception error.

name

java.lang.String name

The field name where the invalid entry was detected.

Package com.amazonaws.services.iot.model

Class com.amazonaws.services.iot.model.AbortConfig extends java.lang.Object implements Serializable

Serialized Fields

criteriaList

java.util.List<AbortCriteria> criteriaList

The list of criteria that determine when and how to abort the job.

Class com.amazonaws.services.iot.model.AbortCriteria extends java.lang.Object implements Serializable

Serialized Fields

action

java.lang.String action

The type of job action to take to initiate the job abort.

Constraints:
Allowed Values: CANCEL

failureType

java.lang.String failureType

The type of job execution failures that can initiate a job abort.

Constraints:
Allowed Values: FAILED, REJECTED, TIMED_OUT, ALL

minNumberOfExecutedThings

java.lang.Integer minNumberOfExecutedThings

The minimum number of things which must receive job execution notifications before the job can be aborted.

Constraints:
Range: 1 -

thresholdPercentage

java.lang.Double thresholdPercentage

The minimum percentage of job execution failures that must occur to initiate the job abort.

Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

Constraints:
Range: - 100.0

Class com.amazonaws.services.iot.model.AcceptCertificateTransferRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

java.lang.String certificateId

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

setAsActive

java.lang.Boolean setAsActive

Specifies whether the certificate is active.

Class com.amazonaws.services.iot.model.Action extends java.lang.Object implements Serializable

Serialized Fields

cloudwatchAlarm

CloudwatchAlarmAction cloudwatchAlarm

Change the state of a CloudWatch alarm.

cloudwatchLogs

CloudwatchLogsAction cloudwatchLogs

Send data to CloudWatch Logs.

cloudwatchMetric

CloudwatchMetricAction cloudwatchMetric

Capture a CloudWatch metric.

dynamoDB

DynamoDBAction dynamoDB

Write to a DynamoDB table.

dynamoDBv2

DynamoDBv2Action dynamoDBv2

Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.

elasticsearch

ElasticsearchAction elasticsearch

Write data to an Amazon OpenSearch Service domain.

The Elasticsearch action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the OpenSearch rule action instead. For more information, see OpenSearchAction.

firehose

FirehoseAction firehose

Write to an Amazon Kinesis Firehose stream.

http

HttpAction http

Send data to an HTTPS endpoint.

iotAnalytics

IotAnalyticsAction iotAnalytics

Sends message data to an IoT Analytics channel.

iotEvents

IotEventsAction iotEvents

Sends an input to an IoT Events detector.

iotSiteWise

IotSiteWiseAction iotSiteWise

Sends data from the MQTT message that triggered the rule to IoT SiteWise asset properties.

kafka

KafkaAction kafka

Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

kinesis

KinesisAction kinesis

Write data to an Amazon Kinesis stream.

lambda

LambdaAction lambda

Invoke a Lambda function.

openSearch

OpenSearchAction openSearch

Write data to an Amazon OpenSearch Service domain.

republish

RepublishAction republish

Publish to another MQTT topic.

s3

S3Action s3

Write to an Amazon S3 bucket.

salesforce

SalesforceAction salesforce

Send a message to a Salesforce IoT Cloud Input Stream.

sns

SnsAction sns

Publish to an Amazon SNS topic.

sqs

SqsAction sqs

Publish to an Amazon SQS queue.

stepFunctions

StepFunctionsAction stepFunctions

Starts execution of a Step Functions state machine.

timestream

TimestreamAction timestream

The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestream topic rule action documentation.

Class com.amazonaws.services.iot.model.ActiveViolation extends java.lang.Object implements Serializable

Serialized Fields

behavior

Behavior behavior

The behavior that is being violated.

lastViolationTime

java.util.Date lastViolationTime

The time the most recent violation occurred.

lastViolationValue

MetricValue lastViolationValue

The value of the metric (the measurement) that caused the most recent violation.

securityProfileName

java.lang.String securityProfileName

The security profile with the behavior is in violation.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingName

java.lang.String thingName

The name of the thing responsible for the active violation.

Constraints:
Length: 1 - 128

verificationState

java.lang.String verificationState

The verification state of the violation (detect alarm).

Constraints:
Allowed Values: FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN

verificationStateDescription

java.lang.String verificationStateDescription

The description of the verification state of the violation.

Constraints:
Length: - 1000
Pattern: [^\p{Cntrl}]*

violationEventAdditionalInfo

ViolationEventAdditionalInfo violationEventAdditionalInfo

The details of a violation event.

violationId

java.lang.String violationId

The ID of the active violation.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+

violationStartTime

java.util.Date violationStartTime

The time the violation started.

Class com.amazonaws.services.iot.model.AddThingsToThingGroupParams extends java.lang.Object implements Serializable

Serialized Fields

overrideDynamicGroups

java.lang.Boolean overrideDynamicGroups

Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic thing groups.

thingGroupNames

java.util.List<java.lang.String> thingGroupNames

The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you can't add a thing to more than one group in the same hierarchy.

Class com.amazonaws.services.iot.model.AddThingToBillingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

billingGroupArn

java.lang.String billingGroupArn

The ARN of the billing group.

billingGroupName

java.lang.String billingGroupName

The name of the billing group.

This call is asynchronous. It might take several seconds for the detachment to propagate.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingArn

java.lang.String thingArn

The ARN of the thing to be added to the billing group.

thingName

java.lang.String thingName

The name of the thing to be added to the billing group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.AddThingToBillingGroupResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.AddThingToThingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

overrideDynamicGroups

java.lang.Boolean overrideDynamicGroups

Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.

thingArn

java.lang.String thingArn

The ARN of the thing to add to a group.

thingGroupArn

java.lang.String thingGroupArn

The ARN of the group to which you are adding a thing.

thingGroupName

java.lang.String thingGroupName

The name of the group to which you are adding a thing.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingName

java.lang.String thingName

The name of the thing to add to a group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.AddThingToThingGroupResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.AggregationType extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the aggregation type.

Constraints:
Allowed Values: Statistics, Percentiles, Cardinality

values

java.util.List<java.lang.String> values

A list of the values of aggregation types.

Class com.amazonaws.services.iot.model.AlertTarget extends java.lang.Object implements Serializable

Serialized Fields

alertTargetArn

java.lang.String alertTargetArn

The Amazon Resource Name (ARN) of the notification target to which alerts are sent.

roleArn

java.lang.String roleArn

The ARN of the role that grants permission to send alerts to the notification target.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.iot.model.Allowed extends java.lang.Object implements Serializable

Serialized Fields

policies

java.util.List<Policy> policies

A list of policies that allowed the authentication.

Class com.amazonaws.services.iot.model.AssetPropertyTimestamp extends java.lang.Object implements Serializable

Serialized Fields

offsetInNanos

java.lang.String offsetInNanos

Optional. A string that contains the nanosecond time offset. Accepts substitution templates.

timeInSeconds

java.lang.String timeInSeconds

A string that contains the time in seconds since epoch. Accepts substitution templates.

Class com.amazonaws.services.iot.model.AssetPropertyValue extends java.lang.Object implements Serializable

Serialized Fields

quality

java.lang.String quality

Optional. A string that describes the quality of the value. Accepts substitution templates. Must be GOOD, BAD, or UNCERTAIN.

timestamp

AssetPropertyTimestamp timestamp

The asset property value timestamp.

value

AssetPropertyVariant value

The value of the asset property.

Class com.amazonaws.services.iot.model.AssetPropertyVariant extends java.lang.Object implements Serializable

Serialized Fields

booleanValue

java.lang.String booleanValue

Optional. A string that contains the boolean value (true or false) of the value entry. Accepts substitution templates.

doubleValue

java.lang.String doubleValue

Optional. A string that contains the double value of the value entry. Accepts substitution templates.

integerValue

java.lang.String integerValue

Optional. A string that contains the integer value of the value entry. Accepts substitution templates.

stringValue

java.lang.String stringValue

Optional. The string value of the value entry. Accepts substitution templates.

Constraints:
Length: 1 - 1024

Class com.amazonaws.services.iot.model.AssociateTargetsWithJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

comment

java.lang.String comment

An optional comment string describing why the job was associated with the targets.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

jobId

java.lang.String jobId

The unique identifier you assigned to this job when it was created.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

namespaceId

java.lang.String namespaceId

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

targets

java.util.List<java.lang.String> targets

A list of thing group ARNs that define the targets of the job.

Class com.amazonaws.services.iot.model.AssociateTargetsWithJobResult extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

A short text description of the job.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

jobArn

java.lang.String jobArn

An ARN identifying the job.

jobId

java.lang.String jobId

The unique identifier you assigned to this job when it was created.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.AttachPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

java.lang.String policyName

The name of the policy to attach.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

target

java.lang.String target

The identity to which the policy is attached. For example, a thing group or a certificate.

Class com.amazonaws.services.iot.model.AttachPrincipalPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

java.lang.String policyName

The policy name.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

principal

java.lang.String principal

The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

Class com.amazonaws.services.iot.model.AttachSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

securityProfileName

java.lang.String securityProfileName

The security profile that is attached.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

securityProfileTargetArn

java.lang.String securityProfileTargetArn

The ARN of the target (thing group) to which the security profile is attached.

Class com.amazonaws.services.iot.model.AttachSecurityProfileResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.AttachThingPrincipalRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

principal

java.lang.String principal

The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

thingName

java.lang.String thingName

The name of the thing.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.AttachThingPrincipalResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.AttributePayload extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

A JSON string containing up to three key-value pair in JSON format. For example:

{\"attributes\":{\"string1\":\"string2\"}}

merge

java.lang.Boolean merge

Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.

The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.

Class com.amazonaws.services.iot.model.AuditCheckConfiguration extends java.lang.Object implements Serializable

Serialized Fields

enabled

java.lang.Boolean enabled

True if this audit check is enabled for this account.

Class com.amazonaws.services.iot.model.AuditCheckDetails extends java.lang.Object implements Serializable

Serialized Fields

checkCompliant

java.lang.Boolean checkCompliant

True if the check is complete and found all resources compliant.

checkRunStatus

java.lang.String checkRunStatus

The completion status of this check. One of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".

Constraints:
Allowed Values: IN_PROGRESS, WAITING_FOR_DATA_COLLECTION, CANCELED, COMPLETED_COMPLIANT, COMPLETED_NON_COMPLIANT, FAILED

errorCode

java.lang.String errorCode

The code of any error encountered when this check is performed during this audit. One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED".

message

java.lang.String message

The message associated with any error encountered when this check is performed during this audit.

Constraints:
Length: - 2048

nonCompliantResourcesCount

java.lang.Long nonCompliantResourcesCount

The number of resources that were found noncompliant during the check.

suppressedNonCompliantResourcesCount

java.lang.Long suppressedNonCompliantResourcesCount

Describes how many of the non-compliant resources created during the evaluation of an audit check were marked as suppressed.

totalResourcesCount

java.lang.Long totalResourcesCount

The number of resources on which the check was performed.

Class com.amazonaws.services.iot.model.AuditFinding extends java.lang.Object implements Serializable

Serialized Fields

checkName

java.lang.String checkName

The audit check that generated this result.

findingId

java.lang.String findingId

A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

findingTime

java.util.Date findingTime

The time the result (finding) was discovered.

isSuppressed

java.lang.Boolean isSuppressed

Indicates whether the audit finding was suppressed or not during reporting.

nonCompliantResource

NonCompliantResource nonCompliantResource

The resource that was found to be noncompliant with the audit check.

reasonForNonCompliance

java.lang.String reasonForNonCompliance

The reason the resource was noncompliant.

reasonForNonComplianceCode

java.lang.String reasonForNonComplianceCode

A code that indicates the reason that the resource was noncompliant.

relatedResources

java.util.List<RelatedResource> relatedResources

The list of related resources.

severity

java.lang.String severity

The severity of the result (finding).

Constraints:
Allowed Values: CRITICAL, HIGH, MEDIUM, LOW

taskId

java.lang.String taskId

The ID of the audit that generated this result (finding).

Constraints:
Length: 1 - 40
Pattern: [a-zA-Z0-9\-]+

taskStartTime

java.util.Date taskStartTime

The time the audit started.

Class com.amazonaws.services.iot.model.AuditMitigationActionExecutionMetadata extends java.lang.Object implements Serializable

Serialized Fields

actionId

java.lang.String actionId

The unique identifier for the mitigation action being applied by the task.

actionName

java.lang.String actionName

The friendly name of the mitigation action being applied by the task.

Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_-]+

endTime

java.util.Date endTime

The date and time when the task was completed or canceled. Blank if the task is still running.

errorCode

java.lang.String errorCode

If an error occurred, the code that indicates which type of error occurred.

findingId

java.lang.String findingId

The unique identifier for the findings to which the task and associated mitigation action are applied.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

message

java.lang.String message

If an error occurred, a message that describes the error.

Constraints:
Length: - 2048

startTime

java.util.Date startTime

The date and time when the task was started.

status

java.lang.String status

The current status of the task being executed.

Constraints:
Allowed Values: IN_PROGRESS, COMPLETED, FAILED, CANCELED, SKIPPED, PENDING

taskId

java.lang.String taskId

The unique identifier for the task that applies the mitigation action.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.AuditMitigationActionsTaskMetadata extends java.lang.Object implements Serializable

Serialized Fields

startTime

java.util.Date startTime

The time at which the audit mitigation actions task was started.

taskId

java.lang.String taskId

The unique identifier for the task.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

taskStatus

java.lang.String taskStatus

The current state of the audit mitigation actions task.

Constraints:
Allowed Values: IN_PROGRESS, COMPLETED, FAILED, CANCELED

Class com.amazonaws.services.iot.model.AuditMitigationActionsTaskTarget extends java.lang.Object implements Serializable

Serialized Fields

auditCheckToReasonCodeFilter

java.util.Map<java.lang.String,java.util.List<java.lang.String>> auditCheckToReasonCodeFilter

Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply.

auditTaskId

java.lang.String auditTaskId

If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.

Constraints:
Length: 1 - 40
Pattern: [a-zA-Z0-9\-]+

findingIds

java.util.List<java.lang.String> findingIds

If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those findings.

Class com.amazonaws.services.iot.model.AuditNotificationTarget extends java.lang.Object implements Serializable

Serialized Fields

enabled

java.lang.Boolean enabled

True if notifications to the target are enabled.

roleArn

java.lang.String roleArn

The ARN of the role that grants permission to send notifications to the target.

Constraints:
Length: 20 - 2048

targetArn

java.lang.String targetArn

The ARN of the target (SNS topic) to which audit notifications are sent.

Constraints:
Length: - 2048

Class com.amazonaws.services.iot.model.AuditSuppression extends java.lang.Object implements Serializable

Serialized Fields

checkName

java.lang.String checkName

An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

description

java.lang.String description

The description of the audit suppression.

Constraints:
Length: - 1000
Pattern: [\p{Graph}\x20]*

expirationDate

java.util.Date expirationDate

The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.

resourceIdentifier

ResourceIdentifier resourceIdentifier

Information that identifies the noncompliant resource.

suppressIndefinitely

java.lang.Boolean suppressIndefinitely

Indicates whether a suppression should exist indefinitely or not.

Class com.amazonaws.services.iot.model.AuditTaskMetadata extends java.lang.Object implements Serializable

Serialized Fields

taskId

java.lang.String taskId

The ID of this audit.

Constraints:
Length: 1 - 40
Pattern: [a-zA-Z0-9\-]+

taskStatus

java.lang.String taskStatus

The status of this audit. One of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

Constraints:
Allowed Values: IN_PROGRESS, COMPLETED, FAILED, CANCELED

taskType

java.lang.String taskType

The type of this audit. One of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".

Constraints:
Allowed Values: ON_DEMAND_AUDIT_TASK, SCHEDULED_AUDIT_TASK

Class com.amazonaws.services.iot.model.AuthInfo extends java.lang.Object implements Serializable

Serialized Fields

actionType

java.lang.String actionType

The type of action for which the principal is being authorized.

Constraints:
Allowed Values: PUBLISH, SUBSCRIBE, RECEIVE, CONNECT

resources

java.util.List<java.lang.String> resources

The resources for which the principal is being authorized to perform the specified action.

Class com.amazonaws.services.iot.model.AuthorizerConfig extends java.lang.Object implements Serializable

Serialized Fields

allowAuthorizerOverride

java.lang.Boolean allowAuthorizerOverride

A Boolean that specifies whether the domain configuration's authorization service can be overridden.

defaultAuthorizerName

java.lang.String defaultAuthorizerName

The name of the authorization service for a domain configuration.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

Class com.amazonaws.services.iot.model.AuthorizerDescription extends java.lang.Object implements Serializable

Serialized Fields

authorizerArn

java.lang.String authorizerArn

The authorizer ARN.

Constraints:
Length: - 2048

authorizerFunctionArn

java.lang.String authorizerFunctionArn

The authorizer's Lambda function ARN.

Constraints:
Length: - 2048
Pattern: [\s\S]*

authorizerName

java.lang.String authorizerName

The authorizer name.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

creationDate

java.util.Date creationDate

The UNIX timestamp of when the authorizer was created.

enableCachingForHttp

java.lang.Boolean enableCachingForHttp

When true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection.

lastModifiedDate

java.util.Date lastModifiedDate

The UNIX timestamp of when the authorizer was last updated.

signingDisabled

java.lang.Boolean signingDisabled

Specifies whether IoT validates the token signature in an authorization request.

status

java.lang.String status

The status of the authorizer.

Constraints:
Allowed Values: ACTIVE, INACTIVE

tokenKeyName

java.lang.String tokenKeyName

The key used to extract the token from the HTTP headers.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

tokenSigningPublicKeys

java.util.Map<java.lang.String,java.lang.String> tokenSigningPublicKeys

The public keys used to validate the token signature returned by your custom authentication service.

Class com.amazonaws.services.iot.model.AuthorizerSummary extends java.lang.Object implements Serializable

Serialized Fields

authorizerArn

java.lang.String authorizerArn

The authorizer ARN.

Constraints:
Length: - 2048

authorizerName

java.lang.String authorizerName

The authorizer name.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

Class com.amazonaws.services.iot.model.AuthResult extends java.lang.Object implements Serializable

Serialized Fields

allowed

Allowed allowed

The policies and statements that allowed the specified action.

authDecision

java.lang.String authDecision

The final authorization decision of this scenario. Multiple statements are taken into account when determining the authorization decision. An explicit deny statement can override multiple allow statements.

Constraints:
Allowed Values: ALLOWED, EXPLICIT_DENY, IMPLICIT_DENY

authInfo

AuthInfo authInfo

Authorization information.

denied

Denied denied

The policies and statements that denied the specified action.

missingContextValues

java.util.List<java.lang.String> missingContextValues

Contains any missing context values found while evaluating policy.

Class com.amazonaws.services.iot.model.AwsJobAbortConfig extends java.lang.Object implements Serializable

Serialized Fields

abortCriteriaList

java.util.List<AwsJobAbortCriteria> abortCriteriaList

The list of criteria that determine when and how to abort the job.

Class com.amazonaws.services.iot.model.AwsJobAbortCriteria extends java.lang.Object implements Serializable

Serialized Fields

action

java.lang.String action

The type of job action to take to initiate the job abort.

Constraints:
Allowed Values: CANCEL

failureType

java.lang.String failureType

The type of job execution failures that can initiate a job abort.

Constraints:
Allowed Values: FAILED, REJECTED, TIMED_OUT, ALL

minNumberOfExecutedThings

java.lang.Integer minNumberOfExecutedThings

The minimum number of things which must receive job execution notifications before the job can be aborted.

Constraints:
Range: 1 -

thresholdPercentage

java.lang.Double thresholdPercentage

The minimum percentage of job execution failures that must occur to initiate the job abort.

Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

Constraints:
Range: - 100.0

Class com.amazonaws.services.iot.model.AwsJobExecutionsRolloutConfig extends java.lang.Object implements Serializable

Serialized Fields

exponentialRate

AwsJobExponentialRolloutRate exponentialRate

The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.

maximumPerMinute

java.lang.Integer maximumPerMinute

The maximum number of OTA update job executions started per minute.

Constraints:
Range: 1 - 1000

Class com.amazonaws.services.iot.model.AwsJobExponentialRolloutRate extends java.lang.Object implements Serializable

Serialized Fields

baseRatePerMinute

java.lang.Integer baseRatePerMinute

The minimum number of things that will be notified of a pending job, per minute, at the start of the job rollout. This is the initial rate of the rollout.

Constraints:
Range: 1 - 1000

incrementFactor

java.lang.Double incrementFactor

The rate of increase for a job rollout. The number of things notified is multiplied by this factor.

rateIncreaseCriteria

AwsJobRateIncreaseCriteria rateIncreaseCriteria

The criteria to initiate the increase in rate of rollout for a job.

Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

Class com.amazonaws.services.iot.model.AwsJobPresignedUrlConfig extends java.lang.Object implements Serializable

Serialized Fields

expiresInSec

java.lang.Long expiresInSec

How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800 seconds. Pre-signed URLs are generated when a request for the job document is received.

Class com.amazonaws.services.iot.model.AwsJobRateIncreaseCriteria extends java.lang.Object implements Serializable

Serialized Fields

numberOfNotifiedThings

java.lang.Integer numberOfNotifiedThings

When this number of things have been notified, it will initiate an increase in the rollout rate.

Constraints:
Range: 1 -

numberOfSucceededThings

java.lang.Integer numberOfSucceededThings

When this number of things have succeeded in their job execution, it will initiate an increase in the rollout rate.

Constraints:
Range: 1 -

Class com.amazonaws.services.iot.model.AwsJobTimeoutConfig extends java.lang.Object implements Serializable

Serialized Fields

inProgressTimeoutInMinutes

java.lang.Long inProgressTimeoutInMinutes

Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

Class com.amazonaws.services.iot.model.Behavior extends java.lang.Object implements Serializable

Serialized Fields

criteria

BehaviorCriteria criteria

The criteria that determine if a device is behaving normally in regard to the metric.

metric

java.lang.String metric

What is measured by the behavior.

metricDimension

MetricDimension metricDimension

The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric to only MQTT topics where the name matches the pattern specified in the dimension. This can't be used with custom metrics.

name

java.lang.String name

The name you've given to the behavior.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

suppressAlerts

java.lang.Boolean suppressAlerts

Suppresses alerts.

Class com.amazonaws.services.iot.model.BehaviorCriteria extends java.lang.Object implements Serializable

Serialized Fields

comparisonOperator

java.lang.String comparisonOperator

The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:

• string-list: in-set and not-in-set

• number-list: in-set and not-in-set

• ip-address-list: in-cidr-set and not-in-cidr-set

• number: less-than, less-than-equals, greater-than, and greater-than-equals

Constraints:
Allowed Values: less-than, less-than-equals, greater-than, greater-than-equals, in-cidr-set, not-in-cidr-set, in-port-set, not-in-port-set, in-set, not-in-set

consecutiveDatapointsToAlarm

java.lang.Integer consecutiveDatapointsToAlarm

If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

Constraints:
Range: 1 - 10

consecutiveDatapointsToClear

java.lang.Integer consecutiveDatapointsToClear

If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

Constraints:
Range: 1 - 10

durationSeconds

java.lang.Integer durationSeconds

Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.

mlDetectionConfig

MachineLearningDetectionConfig mlDetectionConfig

The configuration of an ML Detect

statisticalThreshold

StatisticalThreshold statisticalThreshold

A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

value

MetricValue value

The value to be compared with the metric.

Class com.amazonaws.services.iot.model.BehaviorModelTrainingSummary extends java.lang.Object implements Serializable

Serialized Fields

behaviorName

java.lang.String behaviorName

The name of the behavior.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

datapointsCollectionPercentage

java.lang.Double datapointsCollectionPercentage

The percentage of datapoints collected.

Constraints:
Range: 0.0 - 100.0

lastModelRefreshDate

java.util.Date lastModelRefreshDate

The date the model was last refreshed.

modelStatus

java.lang.String modelStatus

The status of the behavior model.

Constraints:
Allowed Values: PENDING_BUILD, ACTIVE, EXPIRED

securityProfileName

java.lang.String securityProfileName

The name of the security profile.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

trainingDataCollectionStartDate

java.util.Date trainingDataCollectionStartDate

The date a training model started collecting data.

Class com.amazonaws.services.iot.model.BillingGroupMetadata extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The date the billing group was created.

Class com.amazonaws.services.iot.model.BillingGroupProperties extends java.lang.Object implements Serializable

Serialized Fields

billingGroupDescription

java.lang.String billingGroupDescription

The description of the billing group.

Constraints:
Length: - 2028
Pattern: [\p{Graph}\x20]*

Class com.amazonaws.services.iot.model.Bucket extends java.lang.Object implements Serializable

Serialized Fields

count

java.lang.Integer count

The number of documents that have the value counted for the particular bucket.

keyValue

java.lang.String keyValue

The value counted for the particular bucket.

Class com.amazonaws.services.iot.model.BucketsAggregationType extends java.lang.Object implements Serializable

Serialized Fields

termsAggregation

TermsAggregation termsAggregation

Performs an aggregation that will return a list of buckets. The list of buckets is a ranked list of the number of occurrences of an aggregation field value.

Class com.amazonaws.services.iot.model.CACertificate extends java.lang.Object implements Serializable

Serialized Fields

certificateArn

java.lang.String certificateArn

The ARN of the CA certificate.

certificateId

java.lang.String certificateId

The ID of the CA certificate.

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

creationDate

java.util.Date creationDate

The date the CA certificate was created.

status

java.lang.String status

The status of the CA certificate.

The status value REGISTER_INACTIVE is deprecated and should not be used.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Class com.amazonaws.services.iot.model.CACertificateDescription extends java.lang.Object implements Serializable

Serialized Fields

autoRegistrationStatus

java.lang.String autoRegistrationStatus

Whether the CA certificate configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE"

Constraints:
Allowed Values: ENABLE, DISABLE

certificateArn

java.lang.String certificateArn

The CA certificate ARN.

certificateId

java.lang.String certificateId

The CA certificate ID.

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

certificateMode

java.lang.String certificateMode

The mode of the CA.

All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

Constraints:
Allowed Values: DEFAULT, SNI_ONLY

certificatePem

java.lang.String certificatePem

The CA certificate data, in PEM format.

Constraints:
Length: 1 - 65536
Pattern: [\s\S]*

creationDate

java.util.Date creationDate

The date the CA certificate was created.

customerVersion

java.lang.Integer customerVersion

The customer version of the CA certificate.

Constraints:
Range: 1 -

generationId

java.lang.String generationId

The generation ID of the CA certificate.

lastModifiedDate

java.util.Date lastModifiedDate

The date the CA certificate was last modified.

ownedBy

java.lang.String ownedBy

The owner of the CA certificate.

Constraints:
Length: 12 - 12
Pattern: [0-9]+

status

java.lang.String status

The status of a CA certificate.

Constraints:
Allowed Values: ACTIVE, INACTIVE

validity

CertificateValidity validity

When the CA certificate is valid.

Class com.amazonaws.services.iot.model.CancelAuditMitigationActionsTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskId

java.lang.String taskId

The unique identifier for the task that you want to cancel.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.CancelAuditMitigationActionsTaskResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.CancelAuditTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskId

java.lang.String taskId

The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".

Constraints:
Length: 1 - 40
Pattern: [a-zA-Z0-9\-]+

Class com.amazonaws.services.iot.model.CancelAuditTaskResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.CancelCertificateTransferRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

java.lang.String certificateId

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

Class com.amazonaws.services.iot.model.CancelDetectMitigationActionsTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskId

java.lang.String taskId

The unique identifier of the task.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.CancelDetectMitigationActionsTaskResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.CancelJobExecutionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

expectedVersion

java.lang.Long expectedVersion

(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

force

java.lang.Boolean force

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

jobId

java.lang.String jobId

The ID of the job to be canceled.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

statusDetails

java.util.Map<java.lang.String,java.lang.String> statusDetails

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

thingName

java.lang.String thingName

The name of the thing whose execution of the job will be canceled.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.CancelJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

comment

java.lang.String comment

An optional comment string describing why the job was canceled.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

force

java.lang.Boolean force

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

jobId

java.lang.String jobId

The unique identifier you assigned to this job when it was created.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

reasonCode

java.lang.String reasonCode

(Optional)A reason code string that explains why the job was canceled.

Constraints:
Length: - 128
Pattern: [\p{Upper}\p{Digit}_]+

Class com.amazonaws.services.iot.model.CancelJobResult extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

A short text description of the job.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

jobArn

java.lang.String jobArn

The job ARN.

jobId

java.lang.String jobId

The unique identifier you assigned to this job when it was created.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.Certificate extends java.lang.Object implements Serializable

Serialized Fields

certificateArn

java.lang.String certificateArn

The ARN of the certificate.

certificateId

java.lang.String certificateId

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

certificateMode

java.lang.String certificateMode

The mode of the certificate.

DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.

SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.

Constraints:
Allowed Values: DEFAULT, SNI_ONLY

creationDate

java.util.Date creationDate

The date and time the certificate was created.

status

java.lang.String status

The status of the certificate.

The status value REGISTER_INACTIVE is deprecated and should not be used.

Constraints:
Allowed Values: ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, REGISTER_INACTIVE, PENDING_ACTIVATION

Class com.amazonaws.services.iot.model.CertificateConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.CertificateDescription extends java.lang.Object implements Serializable

Serialized Fields

caCertificateId

java.lang.String caCertificateId

The certificate ID of the CA certificate used to sign this certificate.

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

certificateArn

java.lang.String certificateArn

The ARN of the certificate.

certificateId

java.lang.String certificateId

The ID of the certificate.

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

certificateMode

java.lang.String certificateMode

The mode of the certificate.

DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.

SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.

For more information about the value for SNI extension, see Transport security in IoT.

Constraints:
Allowed Values: DEFAULT, SNI_ONLY

certificatePem

java.lang.String certificatePem

The certificate data, in PEM format.

Constraints:
Length: 1 - 65536
Pattern: [\s\S]*

creationDate

java.util.Date creationDate

The date and time the certificate was created.

customerVersion

java.lang.Integer customerVersion

The customer version of the certificate.

Constraints:
Range: 1 -

generationId

java.lang.String generationId

The generation ID of the certificate.

lastModifiedDate

java.util.Date lastModifiedDate

The date and time the certificate was last modified.

ownedBy

java.lang.String ownedBy

The ID of the Amazon Web Services account that owns the certificate.

Constraints:
Length: 12 - 12
Pattern: [0-9]+

previousOwnedBy

java.lang.String previousOwnedBy

The ID of the Amazon Web Services account of the previous owner of the certificate.

Constraints:
Length: 12 - 12
Pattern: [0-9]+

status

java.lang.String status

The status of the certificate.

Constraints:
Allowed Values: ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, REGISTER_INACTIVE, PENDING_ACTIVATION

transferData

TransferData transferData

The transfer data.

validity

CertificateValidity validity

When the certificate is valid.

Class com.amazonaws.services.iot.model.CertificateStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.CertificateValidationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.CertificateValidity extends java.lang.Object implements Serializable

Serialized Fields

notAfter

java.util.Date notAfter

The certificate is not valid after this date.

notBefore

java.util.Date notBefore

The certificate is not valid before this date.

Class com.amazonaws.services.iot.model.ClearDefaultAuthorizerRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.iot.model.ClearDefaultAuthorizerResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.CloudwatchAlarmAction extends java.lang.Object implements Serializable

Serialized Fields

alarmName

java.lang.String alarmName

The CloudWatch alarm name.

roleArn

java.lang.String roleArn

The IAM role that allows access to the CloudWatch alarm.

stateReason

java.lang.String stateReason

The reason for the alarm change.

stateValue

java.lang.String stateValue

The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

Class com.amazonaws.services.iot.model.CloudwatchLogsAction extends java.lang.Object implements Serializable

Serialized Fields

logGroupName

java.lang.String logGroupName

The CloudWatch log group to which the action sends data.

roleArn

java.lang.String roleArn

The IAM role that allows access to the CloudWatch log.

Class com.amazonaws.services.iot.model.CloudwatchMetricAction extends java.lang.Object implements Serializable

Serialized Fields

metricName

java.lang.String metricName

The CloudWatch metric name.

metricNamespace

java.lang.String metricNamespace

The CloudWatch metric namespace name.

metricTimestamp

java.lang.String metricTimestamp

An optional Unix timestamp.

metricUnit

java.lang.String metricUnit

The metric unit supported by CloudWatch.

metricValue

java.lang.String metricValue

The CloudWatch metric value.

roleArn

java.lang.String roleArn

The IAM role that allows access to the CloudWatch metric.

Class com.amazonaws.services.iot.model.CodeSigning extends java.lang.Object implements Serializable

Serialized Fields

awsSignerJobId

java.lang.String awsSignerJobId

The ID of the AWSSignerJob which was created to sign the file.

customCodeSigning

CustomCodeSigning customCodeSigning

A custom method for code signing a file.

startSigningJobParameter

StartSigningJobParameter startSigningJobParameter

Describes the code-signing job.

Class com.amazonaws.services.iot.model.CodeSigningCertificateChain extends java.lang.Object implements Serializable

Serialized Fields

certificateName

java.lang.String certificateName

The name of the certificate.

inlineDocument

java.lang.String inlineDocument

A base64 encoded binary representation of the code signing certificate chain.

Class com.amazonaws.services.iot.model.CodeSigningSignature extends java.lang.Object implements Serializable

Serialized Fields

inlineDocument

java.nio.ByteBuffer inlineDocument

A base64 encoded binary representation of the code signing signature.

Class com.amazonaws.services.iot.model.Configuration extends java.lang.Object implements Serializable

Serialized Fields

enabled

java.lang.Boolean enabled

True to enable the configuration.

Class com.amazonaws.services.iot.model.ConfirmTopicRuleDestinationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

confirmationToken

java.lang.String confirmationToken

The token used to confirm ownership or access to the topic rule confirmation URL.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.iot.model.ConfirmTopicRuleDestinationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.ConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.ConflictingResourceUpdateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.CreateAuditSuppressionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

checkName

java.lang.String checkName

An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

clientRequestToken

java.lang.String clientRequestToken

Each audit supression must have a unique client request token. If you try to create a new audit suppression with the same token as one that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

description

java.lang.String description

The description of the audit suppression.

Constraints:
Length: - 1000
Pattern: [\p{Graph}\x20]*

expirationDate

java.util.Date expirationDate

The epoch timestamp in seconds at which this suppression expires.

resourceIdentifier

ResourceIdentifier resourceIdentifier

Information that identifies the noncompliant resource.

suppressIndefinitely

java.lang.Boolean suppressIndefinitely

Indicates whether a suppression should exist indefinitely or not.

Class com.amazonaws.services.iot.model.CreateAuditSuppressionResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.CreateAuthorizerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

authorizerFunctionArn

java.lang.String authorizerFunctionArn

The ARN of the authorizer's Lambda function.

Constraints:
Length: - 2048
Pattern: [\s\S]*

authorizerName

java.lang.String authorizerName

The authorizer name.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

enableCachingForHttp

java.lang.Boolean enableCachingForHttp

When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds. This value does not affect authorization of clients that use MQTT connections.

The default value is false.

signingDisabled

java.lang.Boolean signingDisabled

Specifies whether IoT validates the token signature in an authorization request.

status

java.lang.String status

The status of the create authorizer request.

Constraints:
Allowed Values: ACTIVE, INACTIVE

tags

java.util.List<Tag> tags

Metadata which can be used to manage the custom authorizer.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

tokenKeyName

java.lang.String tokenKeyName

The name of the token key used to extract the token from the HTTP headers.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

tokenSigningPublicKeys

java.util.Map<java.lang.String,java.lang.String> tokenSigningPublicKeys

The public keys used to verify the digital signature returned by your custom authentication service.

Class com.amazonaws.services.iot.model.CreateAuthorizerResult extends java.lang.Object implements Serializable

Serialized Fields

authorizerArn

java.lang.String authorizerArn

The authorizer ARN.

Constraints:
Length: - 2048

authorizerName

java.lang.String authorizerName

The authorizer's name.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

Class com.amazonaws.services.iot.model.CreateBillingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

billingGroupName

java.lang.String billingGroupName

The name you wish to give to the billing group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

billingGroupProperties

BillingGroupProperties billingGroupProperties

The properties of the billing group.

tags

java.util.List<Tag> tags

Metadata which can be used to manage the billing group.

Class com.amazonaws.services.iot.model.CreateBillingGroupResult extends java.lang.Object implements Serializable

Serialized Fields

billingGroupArn

java.lang.String billingGroupArn

The ARN of the billing group.

billingGroupId

java.lang.String billingGroupId

The ID of the billing group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+

billingGroupName

java.lang.String billingGroupName

The name you gave to the billing group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.CreateCertificateFromCsrRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateSigningRequest

java.lang.String certificateSigningRequest

The certificate signing request (CSR).

Constraints:
Length: 1 - 4096
Pattern: [\s\S]*

setAsActive

java.lang.Boolean setAsActive

Specifies whether the certificate is active.

Class com.amazonaws.services.iot.model.CreateCertificateFromCsrResult extends java.lang.Object implements Serializable

Serialized Fields

certificateArn

java.lang.String certificateArn

The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations.

certificateId

java.lang.String certificateId

The ID of the certificate. Certificate management operations only take a certificateId.

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

certificatePem

java.lang.String certificatePem

The certificate data, in PEM format.

Constraints:
Length: 1 - 65536
Pattern: [\s\S]*

Class com.amazonaws.services.iot.model.CreateCustomMetricRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

displayName

java.lang.String displayName

The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.

Constraints:
Length: - 128
Pattern: [\p{Graph}\x20]*

metricName

java.lang.String metricName

The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws:. You can't change the name after you define it.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

metricType

java.lang.String metricType

The type of the custom metric.

The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

Constraints:
Allowed Values: string-list, ip-address-list, number-list, number

tags

java.util.List<Tag> tags

Metadata that can be used to manage the custom metric.

Class com.amazonaws.services.iot.model.CreateCustomMetricResult extends java.lang.Object implements Serializable

Serialized Fields

metricArn

java.lang.String metricArn

The Amazon Resource Number (ARN) of the custom metric. For example, arn:aws-partition:iot:region:accountId:custommetric/metricName

metricName

java.lang.String metricName

The name of the custom metric to be used in the metric report.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.CreateDimensionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

name

java.lang.String name

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

stringValues

java.util.List<java.lang.String> stringValues

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

tags

java.util.List<Tag> tags

Metadata that can be used to manage the dimension.

type

java.lang.String type

Specifies the type of dimension. Supported types: TOPIC_FILTER.

Constraints:
Allowed Values: TOPIC_FILTER

Class com.amazonaws.services.iot.model.CreateDimensionResult extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the created dimension.

name

java.lang.String name

A unique identifier for the dimension.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.CreateDomainConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

authorizerConfig

AuthorizerConfig authorizerConfig

An object that specifies the authorization service for a domain.

domainConfigurationName

java.lang.String domainConfigurationName

The name of the domain configuration. This value must be unique to a region.

Constraints:
Length: 1 - 128
Pattern: [\w.-]+

domainName

java.lang.String domainName

The name of the domain.

Constraints:
Length: 1 - 253
Pattern: [\s\S]*

serverCertificateArns

java.util.List<java.lang.String> serverCertificateArns

The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains.

serviceType

java.lang.String serviceType

The type of service delivered by the endpoint.

Amazon Web Services IoT Core currently supports only the DATA service type.

Constraints:
Allowed Values: DATA, CREDENTIAL_PROVIDER, JOBS

tags

java.util.List<Tag> tags

Metadata which can be used to manage the domain configuration.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

validationCertificateArn

java.lang.String validationCertificateArn

The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for Amazon Web Services-managed domains.

Constraints:
Length: 1 - 2048
Pattern: arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-| isob-)?[a-z]{4,9}-\d{1}:\d{12}:certificate/[a-zA-Z0-9/-]+

Class com.amazonaws.services.iot.model.CreateDomainConfigurationResult extends java.lang.Object implements Serializable

Serialized Fields

domainConfigurationArn

java.lang.String domainConfigurationArn

The ARN of the domain configuration.

domainConfigurationName

java.lang.String domainConfigurationName

The name of the domain configuration.

Constraints:
Length: 1 - 128
Pattern: [\w.-]+

Class com.amazonaws.services.iot.model.CreateDynamicThingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The dynamic thing group index name.

Currently one index is supported: AWS_Things.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

queryString

java.lang.String queryString

The dynamic thing group search query string.

See Query Syntax for information about query string syntax.

Constraints:
Length: 1 -

queryVersion

java.lang.String queryVersion

The dynamic thing group query version.

Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.

tags

java.util.List<Tag> tags

Metadata which can be used to manage the dynamic thing group.

thingGroupName

java.lang.String thingGroupName

The dynamic thing group name to create.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingGroupProperties

ThingGroupProperties thingGroupProperties

The dynamic thing group properties.

Class com.amazonaws.services.iot.model.CreateDynamicThingGroupResult extends java.lang.Object implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The dynamic thing group index name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

queryString

java.lang.String queryString

The dynamic thing group search query string.

Constraints:
Length: 1 -

queryVersion

java.lang.String queryVersion

The dynamic thing group query version.

thingGroupArn

java.lang.String thingGroupArn

The dynamic thing group ARN.

thingGroupId

java.lang.String thingGroupId

The dynamic thing group ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+

thingGroupName

java.lang.String thingGroupName

The dynamic thing group name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.CreateFleetMetricRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aggregationField

java.lang.String aggregationField

The field to aggregate.

Constraints:
Length: 1 -

aggregationType

AggregationType aggregationType

The type of the aggregation query.

description

java.lang.String description

The fleet metric description.

Constraints:
Length: - 1024
Pattern: [\p{Graph}\x20]*

indexName

java.lang.String indexName

The name of the index to search.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

metricName

java.lang.String metricName

The name of the fleet metric to create.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_\-\.]+

period

java.lang.Integer period

The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

Constraints:
Range: 60 - 86400

queryString

java.lang.String queryString

The search query string.

Constraints:
Length: 1 -

queryVersion

java.lang.String queryVersion

The query version.

tags

java.util.List<Tag> tags

Metadata, which can be used to manage the fleet metric.

unit

java.lang.String unit

Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric. Default to null.

Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

Class com.amazonaws.services.iot.model.CreateFleetMetricResult extends java.lang.Object implements Serializable

Serialized Fields

metricArn

java.lang.String metricArn

The Amazon Resource Name (ARN) of the new fleet metric.

metricName

java.lang.String metricName

The name of the fleet metric to create.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_\-\.]+

Class com.amazonaws.services.iot.model.CreateJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

abortConfig

AbortConfig abortConfig

Allows you to create the criteria to abort a job.

description

java.lang.String description

A short text description of the job.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

document

java.lang.String document

The job document. Required if you don't specify a value for documentSource.

Constraints:
Length: - 32768

documentParameters

java.util.Map<java.lang.String,java.lang.String> documentParameters

Parameters of an Amazon Web Services managed template that you can specify to create the job document.

documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

documentSource

java.lang.String documentSource

An S3 link to the job document. Required if you don't specify a value for document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}

where bucket is your bucket name and key is the object in the bucket to which you are linking.

Constraints:
Length: 1 - 1350

jobExecutionsRetryConfig

JobExecutionsRetryConfig jobExecutionsRetryConfig

Allows you to create the criteria to retry a job.

jobExecutionsRolloutConfig

JobExecutionsRolloutConfig jobExecutionsRolloutConfig

Allows you to create a staged rollout of the job.

jobId

java.lang.String jobId

A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

jobTemplateArn

java.lang.String jobTemplateArn

The ARN of the job template used to create the job.

Constraints:
Length: 1 - 1600
Pattern: ^arn:[!-~]+$

namespaceId

java.lang.String namespaceId

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

presignedUrlConfig

PresignedUrlConfig presignedUrlConfig

Configuration information for pre-signed S3 URLs.

tags

java.util.List<Tag> tags

Metadata which can be used to manage the job.

targets

java.util.List<java.lang.String> targets

A list of things and thing groups to which the job should be sent.

targetSelection

java.lang.String targetSelection

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT

timeoutConfig

TimeoutConfig timeoutConfig

Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.

Class com.amazonaws.services.iot.model.CreateJobResult extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

The job description.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

jobArn

java.lang.String jobArn

The job ARN.

jobId

java.lang.String jobId

The unique identifier you assigned to this job.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.CreateJobTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

abortConfig

AbortConfig abortConfig

The criteria that determine when and how a job abort takes place.

description

java.lang.String description

A description of the job document.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

document

java.lang.String document

The job document. Required if you don't specify a value for documentSource.

Constraints:
Length: - 32768

documentSource

java.lang.String documentSource

An S3 link to the job document to use in the template. Required if you don't specify a value for document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}

where bucket is your bucket name and key is the object in the bucket to which you are linking.

Constraints:
Length: 1 - 1350

jobArn

java.lang.String jobArn

The ARN of the job to use as the basis for the job template.

jobExecutionsRetryConfig

JobExecutionsRetryConfig jobExecutionsRetryConfig

Allows you to create the criteria to retry a job.

jobExecutionsRolloutConfig

JobExecutionsRolloutConfig jobExecutionsRolloutConfig

Allows you to create a staged rollout of a job.

jobTemplateId

java.lang.String jobTemplateId

A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

presignedUrlConfig

PresignedUrlConfig presignedUrlConfig

Configuration for pre-signed S3 URLs.

tags

java.util.List<Tag> tags

Metadata that can be used to manage the job template.

timeoutConfig

TimeoutConfig timeoutConfig

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Class com.amazonaws.services.iot.model.CreateJobTemplateResult extends java.lang.Object implements Serializable

Serialized Fields

jobTemplateArn

java.lang.String jobTemplateArn

The ARN of the job template.

Constraints:
Length: 1 - 1600
Pattern: ^arn:[!-~]+$

jobTemplateId

java.lang.String jobTemplateId

The unique identifier of the job template.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.CreateKeysAndCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

setAsActive

java.lang.Boolean setAsActive

Specifies whether the certificate is active.

Class com.amazonaws.services.iot.model.CreateKeysAndCertificateResult extends java.lang.Object implements Serializable

Serialized Fields

certificateArn

java.lang.String certificateArn

The ARN of the certificate.

certificateId

java.lang.String certificateId

The ID of the certificate. IoT issues a default subject name for the certificate (for example, IoT Certificate).

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

certificatePem

java.lang.String certificatePem

The certificate data, in PEM format.

Constraints:
Length: 1 - 65536
Pattern: [\s\S]*

keyPair

KeyPair keyPair

The generated key pair.

Class com.amazonaws.services.iot.model.CreateMitigationActionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

actionName

java.lang.String actionName

A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_-]+

actionParams

MitigationActionParams actionParams

Defines the type of action and the parameters for that action.

roleArn

java.lang.String roleArn

The ARN of the IAM role that is used to apply the mitigation action.

Constraints:
Length: 20 - 2048

tags

java.util.List<Tag> tags

Metadata that can be used to manage the mitigation action.

Class com.amazonaws.services.iot.model.CreateMitigationActionResult extends java.lang.Object implements Serializable

Serialized Fields

actionArn

java.lang.String actionArn

The ARN for the new mitigation action.

actionId

java.lang.String actionId

A unique identifier for the new mitigation action.

Class com.amazonaws.services.iot.model.CreateOTAUpdateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

additionalParameters

java.util.Map<java.lang.String,java.lang.String> additionalParameters

A list of additional OTA update parameters which are name-value pairs.

awsJobAbortConfig

AwsJobAbortConfig awsJobAbortConfig

The criteria that determine when and how a job abort takes place.

awsJobExecutionsRolloutConfig

AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig

Configuration for the rollout of OTA updates.

awsJobPresignedUrlConfig

AwsJobPresignedUrlConfig awsJobPresignedUrlConfig

Configuration information for pre-signed URLs.

awsJobTimeoutConfig

AwsJobTimeoutConfig awsJobTimeoutConfig

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

description

java.lang.String description

The description of the OTA update.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

files

java.util.List<OTAUpdateFile> files

The files to be streamed by the OTA update.

otaUpdateId

java.lang.String otaUpdateId

The ID of the OTA update to be created.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

protocols

java.util.List<java.lang.String> protocols

The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.

roleArn

java.lang.String roleArn

The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.

Constraints:
Length: 20 - 2048

tags

java.util.List<Tag> tags

Metadata which can be used to manage updates.

targets

java.util.List<java.lang.String> targets

The devices targeted to receive OTA updates.

targetSelection

java.lang.String targetSelection

Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.

Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT

Class com.amazonaws.services.iot.model.CreateOTAUpdateResult extends java.lang.Object implements Serializable

Serialized Fields

awsIotJobArn

java.lang.String awsIotJobArn

The IoT job ARN associated with the OTA update.

awsIotJobId

java.lang.String awsIotJobId

The IoT job ID associated with the OTA update.

otaUpdateArn

java.lang.String otaUpdateArn

The OTA update ARN.

otaUpdateId

java.lang.String otaUpdateId

The OTA update ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

otaUpdateStatus

java.lang.String otaUpdateStatus

The OTA update status.

Constraints:
Allowed Values: CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_COMPLETE, CREATE_FAILED

Class com.amazonaws.services.iot.model.CreatePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyDocument

java.lang.String policyDocument

The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.

Constraints:
Length: 0 - 404600
Pattern: [\s\S]*

policyName

java.lang.String policyName

The policy name.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

tags

java.util.List<Tag> tags

Metadata which can be used to manage the policy.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Class com.amazonaws.services.iot.model.CreatePolicyResult extends java.lang.Object implements Serializable

Serialized Fields

policyArn

java.lang.String policyArn

The policy ARN.

policyDocument

java.lang.String policyDocument

The JSON document that describes the policy.

Constraints:
Length: 0 - 404600
Pattern: [\s\S]*

policyName

java.lang.String policyName

The policy name.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

policyVersionId

java.lang.String policyVersionId

The policy version ID.

Constraints:
Pattern: [0-9]+

Class com.amazonaws.services.iot.model.CreatePolicyVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyDocument

java.lang.String policyDocument

The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.

Constraints:
Length: 0 - 404600
Pattern: [\s\S]*

policyName

java.lang.String policyName

The policy name.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

setAsDefault

java.lang.Boolean setAsDefault

Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Class com.amazonaws.services.iot.model.CreatePolicyVersionResult extends java.lang.Object implements Serializable

Serialized Fields

isDefaultVersion

java.lang.Boolean isDefaultVersion

Specifies whether the policy version is the default.

policyArn

java.lang.String policyArn

The policy ARN.

policyDocument

java.lang.String policyDocument

The JSON document that describes the policy.

Constraints:
Length: 0 - 404600
Pattern: [\s\S]*

policyVersionId

java.lang.String policyVersionId

The policy version ID.

Constraints:
Pattern: [0-9]+

Class com.amazonaws.services.iot.model.CreateProvisioningClaimRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

templateName

java.lang.String templateName

The name of the provisioning template to use.

Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$

Class com.amazonaws.services.iot.model.CreateProvisioningClaimResult extends java.lang.Object implements Serializable

Serialized Fields

certificateId

java.lang.String certificateId

The ID of the certificate.

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

certificatePem

java.lang.String certificatePem

The provisioning claim certificate.

Constraints:
Length: 1 - 65536
Pattern: [\s\S]*

expiration

java.util.Date expiration

The provisioning claim expiration time.

keyPair

KeyPair keyPair

The provisioning claim key pair.

Class com.amazonaws.services.iot.model.CreateProvisioningTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

The description of the provisioning template.

Constraints:
Length: 0 - 500
Pattern: [^\p{C}]*

enabled

java.lang.Boolean enabled

True to enable the provisioning template, otherwise false.

preProvisioningHook

ProvisioningHook preProvisioningHook

Creates a pre-provisioning hook template.

provisioningRoleArn

java.lang.String provisioningRoleArn

The role ARN for the role associated with the provisioning template. This IoT role grants permission to provision a device.

Constraints:
Length: 20 - 2048

tags

java.util.List<Tag> tags

Metadata which can be used to manage the provisioning template.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

templateBody

java.lang.String templateBody

The JSON formatted contents of the provisioning template.

Constraints:
Length: 0 - 10240
Pattern: [\s\S]*

templateName

java.lang.String templateName

The name of the provisioning template.

Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$

type

java.lang.String type

The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template.

Constraints:
Allowed Values: FLEET_PROVISIONING, JITP

Class com.amazonaws.services.iot.model.CreateProvisioningTemplateResult extends java.lang.Object implements Serializable

Serialized Fields

defaultVersionId

java.lang.Integer defaultVersionId

The default version of the provisioning template.

templateArn

java.lang.String templateArn

The ARN that identifies the provisioning template.

templateName

java.lang.String templateName

The name of the provisioning template.

Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$

Class com.amazonaws.services.iot.model.CreateProvisioningTemplateVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

setAsDefault

java.lang.Boolean setAsDefault

Sets a fleet provision template version as the default version.

templateBody

java.lang.String templateBody

The JSON formatted contents of the provisioning template.

Constraints:
Length: 0 - 10240
Pattern: [\s\S]*

templateName

java.lang.String templateName

The name of the provisioning template.

Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$

Class com.amazonaws.services.iot.model.CreateProvisioningTemplateVersionResult extends java.lang.Object implements Serializable

Serialized Fields

isDefaultVersion

java.lang.Boolean isDefaultVersion

True if the provisioning template version is the default version, otherwise false.

templateArn

java.lang.String templateArn

The ARN that identifies the provisioning template.

templateName

java.lang.String templateName

The name of the provisioning template.

Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$

versionId

java.lang.Integer versionId

The version of the provisioning template.

Class com.amazonaws.services.iot.model.CreateRoleAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

credentialDurationSeconds

java.lang.Integer credentialDurationSeconds

How long (in seconds) the credentials will be valid. The default value is 3,600 seconds.

This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.

Constraints:
Range: 900 - 43200

roleAlias

java.lang.String roleAlias

The role alias that points to a role ARN. This allows you to change the role without having to update the device.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

roleArn

java.lang.String roleArn

The role ARN.

Constraints:
Length: 20 - 2048

tags

java.util.List<Tag> tags

Metadata which can be used to manage the role alias.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Class com.amazonaws.services.iot.model.CreateRoleAliasResult extends java.lang.Object implements Serializable

Serialized Fields

roleAlias

java.lang.String roleAlias

The role alias.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

roleAliasArn

java.lang.String roleAliasArn

The role alias ARN.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.iot.model.CreateScheduledAuditRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dayOfMonth

java.lang.String dayOfMonth

The day of the month on which the scheduled audit takes place. This can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to MONTHLY. If days 29 to 31 are specified, and the month doesn't have that many days, the audit takes place on the LAST day of the month.

Constraints:
Pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$

dayOfWeek

java.lang.String dayOfWeek

The day of the week on which the scheduled audit takes place, either SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.

Constraints:
Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT

frequency

java.lang.String frequency

How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY or MONTHLY. The start time of each audit is determined by the system.

Constraints:
Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY

scheduledAuditName

java.lang.String scheduledAuditName

The name you want to give to the scheduled audit. (Max. 128 chars)

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

tags

java.util.List<Tag> tags

Metadata that can be used to manage the scheduled audit.

targetCheckNames

java.util.List<java.lang.String> targetCheckNames

Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

Class com.amazonaws.services.iot.model.CreateScheduledAuditResult extends java.lang.Object implements Serializable

Serialized Fields

scheduledAuditArn

java.lang.String scheduledAuditArn

The ARN of the scheduled audit.

Class com.amazonaws.services.iot.model.CreateSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

additionalMetricsToRetain

java.util.List<java.lang.String> additionalMetricsToRetain

Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

additionalMetricsToRetainV2

java.util.List<MetricToRetain> additionalMetricsToRetainV2

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

alertTargets

java.util.Map<java.lang.String,AlertTarget> alertTargets

Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

behaviors

java.util.List<Behavior> behaviors

Specifies the behaviors that, when violated by a device (thing), cause an alert.

securityProfileDescription

java.lang.String securityProfileDescription

A description of the security profile.

Constraints:
Length: - 1000
Pattern: [\p{Graph}\x20]*

securityProfileName

java.lang.String securityProfileName

The name you are giving to the security profile.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

tags

java.util.List<Tag> tags

Metadata that can be used to manage the security profile.

Class com.amazonaws.services.iot.model.CreateSecurityProfileResult extends java.lang.Object implements Serializable

Serialized Fields

securityProfileArn

java.lang.String securityProfileArn

The ARN of the security profile.

securityProfileName

java.lang.String securityProfileName

The name you gave to the security profile.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.CreateStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

A description of the stream.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

files

java.util.List<StreamFile> files

The files to stream.

roleArn

java.lang.String roleArn

An IAM role that allows the IoT service principal to access your S3 files.

Constraints:
Length: 20 - 2048

streamId

java.lang.String streamId

The stream ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

tags

java.util.List<Tag> tags

Metadata which can be used to manage streams.

Class com.amazonaws.services.iot.model.CreateStreamResult extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

A description of the stream.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

streamArn

java.lang.String streamArn

The stream ARN.

streamId

java.lang.String streamId

The stream ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

streamVersion

java.lang.Integer streamVersion

The version of the stream.

Constraints:
Range: 0 - 65535

Class com.amazonaws.services.iot.model.CreateThingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

parentGroupName

java.lang.String parentGroupName

The name of the parent thing group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

tags

java.util.List<Tag> tags

Metadata which can be used to manage the thing group.

thingGroupName

java.lang.String thingGroupName

The thing group name to create.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingGroupProperties

ThingGroupProperties thingGroupProperties

The thing group properties.

Class com.amazonaws.services.iot.model.CreateThingGroupResult extends java.lang.Object implements Serializable

Serialized Fields

thingGroupArn

java.lang.String thingGroupArn

The thing group ARN.

thingGroupId

java.lang.String thingGroupId

The thing group ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+

thingGroupName

java.lang.String thingGroupName

The thing group name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.CreateThingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributePayload

AttributePayload attributePayload

The attribute payload, which consists of up to three name/value pairs in a JSON document. For example:

{\"attributes\":{\"string1\":\"string2\"}}

billingGroupName

java.lang.String billingGroupName

The name of the billing group the thing will be added to.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingName

java.lang.String thingName

The name of the thing to create.

You can't change a thing's name after you create it. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingTypeName

java.lang.String thingTypeName

The name of the thing type associated with the new thing.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.CreateThingResult extends java.lang.Object implements Serializable

Serialized Fields

thingArn

java.lang.String thingArn

The ARN of the new thing.

thingId

java.lang.String thingId

The thing ID.

thingName

java.lang.String thingName

The name of the new thing.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.CreateThingTypeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tags

java.util.List<Tag> tags

Metadata which can be used to manage the thing type.

thingTypeName

java.lang.String thingTypeName

The name of the thing type.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingTypeProperties

ThingTypeProperties thingTypeProperties

The ThingTypeProperties for the thing type to create. It contains information about the new thing type including a description, and a list of searchable thing attribute names.

Class com.amazonaws.services.iot.model.CreateThingTypeResult extends java.lang.Object implements Serializable

Serialized Fields

thingTypeArn

java.lang.String thingTypeArn

The Amazon Resource Name (ARN) of the thing type.

thingTypeId

java.lang.String thingTypeId

The thing type ID.

thingTypeName

java.lang.String thingTypeName

The name of the thing type.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.CreateTopicRuleDestinationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationConfiguration

TopicRuleDestinationConfiguration destinationConfiguration

The topic rule destination configuration.

Class com.amazonaws.services.iot.model.CreateTopicRuleDestinationResult extends java.lang.Object implements Serializable

Serialized Fields

topicRuleDestination

TopicRuleDestination topicRuleDestination

The topic rule destination.

Class com.amazonaws.services.iot.model.CreateTopicRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleName

java.lang.String ruleName

The name of the rule.

Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$

tags

java.lang.String tags

Metadata which can be used to manage the topic rule.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

topicRulePayload

TopicRulePayload topicRulePayload

The rule payload.

Class com.amazonaws.services.iot.model.CustomCodeSigning extends java.lang.Object implements Serializable

Serialized Fields

certificateChain

CodeSigningCertificateChain certificateChain

The certificate chain.

hashAlgorithm

java.lang.String hashAlgorithm

The hash algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses SHA256 or SHA1, so you can pass either of them based on which was used for generating the signature.

signature

CodeSigningSignature signature

The signature for the file.

signatureAlgorithm

java.lang.String signatureAlgorithm

The signature algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses ECDSA or RSA, so you can pass either of them based on which was used for generating the signature.

Class com.amazonaws.services.iot.model.DeleteAccountAuditConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deleteScheduledAudits

java.lang.Boolean deleteScheduledAudits

If true, all scheduled audits are deleted.

Class com.amazonaws.services.iot.model.DeleteAccountAuditConfigurationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteAuditSuppressionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

checkName

java.lang.String checkName

An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

resourceIdentifier

ResourceIdentifier resourceIdentifier

Information that identifies the noncompliant resource.

Class com.amazonaws.services.iot.model.DeleteAuditSuppressionResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteAuthorizerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

authorizerName

java.lang.String authorizerName

The name of the authorizer to delete.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

Class com.amazonaws.services.iot.model.DeleteAuthorizerResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteBillingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

billingGroupName

java.lang.String billingGroupName

The name of the billing group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

expectedVersion

java.lang.Long expectedVersion

The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the DeleteBillingGroup request is rejected with a VersionConflictException.

Class com.amazonaws.services.iot.model.DeleteBillingGroupResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteCACertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

java.lang.String certificateId

The ID of the certificate to delete. (The last part of the certificate ARN contains the certificate ID.)

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

Class com.amazonaws.services.iot.model.DeleteCACertificateResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

java.lang.String certificateId

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

forceDelete

java.lang.Boolean forceDelete

Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing.

Class com.amazonaws.services.iot.model.DeleteConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.DeleteCustomMetricRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

metricName

java.lang.String metricName

The name of the custom metric.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DeleteCustomMetricResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteDimensionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

java.lang.String name

The unique identifier for the dimension that you want to delete.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DeleteDimensionResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteDomainConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainConfigurationName

java.lang.String domainConfigurationName

The name of the domain configuration to be deleted.

Constraints:
Length: 1 - 128
Pattern: [\w.-]+

Class com.amazonaws.services.iot.model.DeleteDomainConfigurationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteDynamicThingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

expectedVersion

java.lang.Long expectedVersion

The expected version of the dynamic thing group to delete.

thingGroupName

java.lang.String thingGroupName

The name of the dynamic thing group to delete.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DeleteDynamicThingGroupResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteFleetMetricRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

expectedVersion

java.lang.Long expectedVersion

The expected version of the fleet metric to delete.

metricName

java.lang.String metricName

The name of the fleet metric to delete.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_\-\.]+

Class com.amazonaws.services.iot.model.DeleteJobExecutionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

executionNumber

java.lang.Long executionNumber

The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.

Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.

force

java.lang.Boolean force

(Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false.

Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

jobId

java.lang.String jobId

The ID of the job whose execution on a particular device will be deleted.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

namespaceId

java.lang.String namespaceId

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

thingName

java.lang.String thingName

The name of the thing whose job execution will be deleted.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DeleteJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

force

java.lang.Boolean force

(Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.

Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted is able to recover to a valid state.

jobId

java.lang.String jobId

The ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

namespaceId

java.lang.String namespaceId

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.DeleteJobTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobTemplateId

java.lang.String jobTemplateId

The unique identifier of the job template to delete.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.DeleteMitigationActionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

actionName

java.lang.String actionName

The name of the mitigation action that you want to delete.

Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.DeleteMitigationActionResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteOTAUpdateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deleteStream

java.lang.Boolean deleteStream

When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.

forceDeleteAWSJob

java.lang.Boolean forceDeleteAWSJob

When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.

otaUpdateId

java.lang.String otaUpdateId

The ID of the OTA update to delete.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.DeleteOTAUpdateResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeletePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

java.lang.String policyName

The name of the policy to delete.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Class com.amazonaws.services.iot.model.DeletePolicyVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

java.lang.String policyName

The name of the policy.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

policyVersionId

java.lang.String policyVersionId

The policy version ID.

Constraints:
Pattern: [0-9]+

Class com.amazonaws.services.iot.model.DeleteProvisioningTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

templateName

java.lang.String templateName

The name of the fleet provision template to delete.

Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$

Class com.amazonaws.services.iot.model.DeleteProvisioningTemplateResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteProvisioningTemplateVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

templateName

java.lang.String templateName

The name of the provisioning template version to delete.

Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$

versionId

java.lang.Integer versionId

The provisioning template version ID to delete.

Class com.amazonaws.services.iot.model.DeleteProvisioningTemplateVersionResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteRegistrationCodeRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.iot.model.DeleteRegistrationCodeResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteRoleAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

roleAlias

java.lang.String roleAlias

The role alias to delete.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

Class com.amazonaws.services.iot.model.DeleteRoleAliasResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteScheduledAuditRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

scheduledAuditName

java.lang.String scheduledAuditName

The name of the scheduled audit you want to delete.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.DeleteScheduledAuditResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

expectedVersion

java.lang.Long expectedVersion

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

securityProfileName

java.lang.String securityProfileName

The name of the security profile to be deleted.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DeleteSecurityProfileResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamId

java.lang.String streamId

The stream ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.DeleteStreamResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteThingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

expectedVersion

java.lang.Long expectedVersion

The expected version of the thing group to delete.

thingGroupName

java.lang.String thingGroupName

The name of the thing group to delete.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DeleteThingGroupResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteThingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

expectedVersion

java.lang.Long expectedVersion

The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the DeleteThing request is rejected with a VersionConflictException.

thingName

java.lang.String thingName

The name of the thing to delete.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DeleteThingResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteThingTypeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

thingTypeName

java.lang.String thingTypeName

The name of the thing type.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DeleteThingTypeResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteTopicRuleDestinationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

java.lang.String arn

The ARN of the topic rule destination to delete.

Class com.amazonaws.services.iot.model.DeleteTopicRuleDestinationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteTopicRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleName

java.lang.String ruleName

The name of the rule.

Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$

Class com.amazonaws.services.iot.model.DeleteV2LoggingLevelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

targetName

java.lang.String targetName

The name of the resource for which you are configuring logging.

targetType

java.lang.String targetType

The type of resource for which you are configuring logging. Must be THING_Group.

Constraints:
Allowed Values: DEFAULT, THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID

Class com.amazonaws.services.iot.model.Denied extends java.lang.Object implements Serializable

Serialized Fields

explicitDeny

ExplicitDeny explicitDeny

Information that explicitly denies the authorization.

implicitDeny

ImplicitDeny implicitDeny

Information that implicitly denies the authorization. When a policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.

Class com.amazonaws.services.iot.model.DeprecateThingTypeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

thingTypeName

java.lang.String thingTypeName

The name of the thing type to deprecate.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

undoDeprecate

java.lang.Boolean undoDeprecate

Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and you can associate it with things.

Class com.amazonaws.services.iot.model.DeprecateThingTypeResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DescribeAccountAuditConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.iot.model.DescribeAccountAuditConfigurationResult extends java.lang.Object implements Serializable

Serialized Fields

auditCheckConfigurations

java.util.Map<java.lang.String,AuditCheckConfiguration> auditCheckConfigurations

Which audit checks are enabled and disabled for this account.

auditNotificationTargetConfigurations

java.util.Map<java.lang.String,AuditNotificationTarget> auditNotificationTargetConfigurations

Information about the targets to which audit notifications are sent for this account.

roleArn

java.lang.String roleArn

The ARN of the role that grants permission to IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.

On the first call to UpdateAccountAuditConfiguration, this parameter is required.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.iot.model.DescribeAuditFindingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

findingId

java.lang.String findingId

A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.DescribeAuditFindingResult extends java.lang.Object implements Serializable

Serialized Fields

finding

AuditFinding finding

The findings (results) of the audit.

Class com.amazonaws.services.iot.model.DescribeAuditMitigationActionsTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskId

java.lang.String taskId

The unique identifier for the audit mitigation task.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.DescribeAuditMitigationActionsTaskResult extends java.lang.Object implements Serializable

Serialized Fields

actionsDefinition

java.util.List<MitigationAction> actionsDefinition

Specifies the mitigation actions and their parameters that are applied as part of this task.

auditCheckToActionsMapping

java.util.Map<java.lang.String,java.util.List<java.lang.String>> auditCheckToActionsMapping

Specifies the mitigation actions that should be applied to specific audit checks.

endTime

java.util.Date endTime

The date and time when the task was completed or canceled.

startTime

java.util.Date startTime

The date and time when the task was started.

target

AuditMitigationActionsTaskTarget target

Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.

taskStatistics

java.util.Map<java.lang.String,TaskStatisticsForAuditCheck> taskStatistics

Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.

taskStatus

java.lang.String taskStatus

The current status of the task.

Constraints:
Allowed Values: IN_PROGRESS, COMPLETED, FAILED, CANCELED

Class com.amazonaws.services.iot.model.DescribeAuditSuppressionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

checkName

java.lang.String checkName

An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

resourceIdentifier

ResourceIdentifier resourceIdentifier

Information that identifies the noncompliant resource.

Class com.amazonaws.services.iot.model.DescribeAuditSuppressionResult extends java.lang.Object implements Serializable

Serialized Fields

checkName

java.lang.String checkName

An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

description

java.lang.String description

The description of the audit suppression.

Constraints:
Length: - 1000
Pattern: [\p{Graph}\x20]*

expirationDate

java.util.Date expirationDate

The epoch timestamp in seconds at which this suppression expires.

resourceIdentifier

ResourceIdentifier resourceIdentifier

Information that identifies the noncompliant resource.

suppressIndefinitely

java.lang.Boolean suppressIndefinitely

Indicates whether a suppression should exist indefinitely or not.

Class com.amazonaws.services.iot.model.DescribeAuditTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskId

java.lang.String taskId

The ID of the audit whose information you want to get.

Constraints:
Length: 1 - 40
Pattern: [a-zA-Z0-9\-]+

Class com.amazonaws.services.iot.model.DescribeAuditTaskResult extends java.lang.Object implements Serializable

Serialized Fields

auditDetails

java.util.Map<java.lang.String,AuditCheckDetails> auditDetails

Detailed information about each check performed during this audit.

scheduledAuditName

java.lang.String scheduledAuditName

The name of the scheduled audit (only if the audit was a scheduled audit).

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

taskStartTime

java.util.Date taskStartTime

The time the audit started.

taskStatistics

TaskStatistics taskStatistics

Statistical information about the audit.

taskStatus

java.lang.String taskStatus

The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

Constraints:
Allowed Values: IN_PROGRESS, COMPLETED, FAILED, CANCELED

taskType

java.lang.String taskType

The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".

Constraints:
Allowed Values: ON_DEMAND_AUDIT_TASK, SCHEDULED_AUDIT_TASK

Class com.amazonaws.services.iot.model.DescribeAuthorizerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

authorizerName

java.lang.String authorizerName

The name of the authorizer to describe.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

Class com.amazonaws.services.iot.model.DescribeAuthorizerResult extends java.lang.Object implements Serializable

Serialized Fields

authorizerDescription

AuthorizerDescription authorizerDescription

The authorizer description.

Class com.amazonaws.services.iot.model.DescribeBillingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

billingGroupName

java.lang.String billingGroupName

The name of the billing group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DescribeBillingGroupResult extends java.lang.Object implements Serializable

Serialized Fields

billingGroupArn

java.lang.String billingGroupArn

The ARN of the billing group.

billingGroupId

java.lang.String billingGroupId

The ID of the billing group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+

billingGroupMetadata

BillingGroupMetadata billingGroupMetadata

Additional information about the billing group.

billingGroupName

java.lang.String billingGroupName

The name of the billing group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

billingGroupProperties

BillingGroupProperties billingGroupProperties

The properties of the billing group.

version

java.lang.Long version

The version of the billing group.

Class com.amazonaws.services.iot.model.DescribeCACertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

java.lang.String certificateId

The CA certificate identifier.

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

Class com.amazonaws.services.iot.model.DescribeCACertificateResult extends java.lang.Object implements Serializable

Serialized Fields

certificateDescription

CACertificateDescription certificateDescription

The CA certificate description.

registrationConfig

RegistrationConfig registrationConfig

Information about the registration configuration.

Class com.amazonaws.services.iot.model.DescribeCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

java.lang.String certificateId

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

Class com.amazonaws.services.iot.model.DescribeCertificateResult extends java.lang.Object implements Serializable

Serialized Fields

certificateDescription

CertificateDescription certificateDescription

The description of the certificate.

Class com.amazonaws.services.iot.model.DescribeCustomMetricRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

metricName

java.lang.String metricName

The name of the custom metric.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DescribeCustomMetricResult extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The creation date of the custom metric in milliseconds since epoch.

displayName

java.lang.String displayName

Field represents a friendly name in the console for the custom metric; doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.

Constraints:
Length: - 128
Pattern: [\p{Graph}\x20]*

lastModifiedDate

java.util.Date lastModifiedDate

The time the custom metric was last modified in milliseconds since epoch.

metricArn

java.lang.String metricArn

The Amazon Resource Number (ARN) of the custom metric.

metricName

java.lang.String metricName

The name of the custom metric.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

metricType

java.lang.String metricType

The type of the custom metric.

The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

Constraints:
Allowed Values: string-list, ip-address-list, number-list, number

Class com.amazonaws.services.iot.model.DescribeDefaultAuthorizerRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.iot.model.DescribeDefaultAuthorizerResult extends java.lang.Object implements Serializable

Serialized Fields

authorizerDescription

AuthorizerDescription authorizerDescription

The default authorizer's description.

Class com.amazonaws.services.iot.model.DescribeDetectMitigationActionsTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskId

java.lang.String taskId

The unique identifier of the task.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.DescribeDetectMitigationActionsTaskResult extends java.lang.Object implements Serializable

Serialized Fields

taskSummary

DetectMitigationActionsTaskSummary taskSummary

The description of a task.

Class com.amazonaws.services.iot.model.DescribeDimensionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

java.lang.String name

The unique identifier for the dimension.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DescribeDimensionResult extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) for the dimension.

creationDate

java.util.Date creationDate

The date the dimension was created.

lastModifiedDate

java.util.Date lastModifiedDate

The date the dimension was last modified.

name

java.lang.String name

The unique identifier for the dimension.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

stringValues

java.util.List<java.lang.String> stringValues

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

type

java.lang.String type

The type of the dimension.

Constraints:
Allowed Values: TOPIC_FILTER

Class com.amazonaws.services.iot.model.DescribeDomainConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainConfigurationName

java.lang.String domainConfigurationName

The name of the domain configuration.

Constraints:
Length: 1 - 128
Pattern: [\w.:-]+

Class com.amazonaws.services.iot.model.DescribeDomainConfigurationResult extends java.lang.Object implements Serializable

Serialized Fields

authorizerConfig

AuthorizerConfig authorizerConfig

An object that specifies the authorization service for a domain.

domainConfigurationArn

java.lang.String domainConfigurationArn

The ARN of the domain configuration.

domainConfigurationName

java.lang.String domainConfigurationName

The name of the domain configuration.

Constraints:
Length: 1 - 128
Pattern: [\w.:-]+

domainConfigurationStatus

java.lang.String domainConfigurationStatus

A Boolean value that specifies the current state of the domain configuration.

Constraints:
Allowed Values: ENABLED, DISABLED

domainName

java.lang.String domainName

The name of the domain.

Constraints:
Length: 1 - 253
Pattern: [\s\S]*

domainType

java.lang.String domainType

The type of the domain.

Constraints:
Allowed Values: ENDPOINT, AWS_MANAGED, CUSTOMER_MANAGED

lastStatusChangeDate

java.util.Date lastStatusChangeDate

The date and time the domain configuration's status was last changed.

serverCertificates

java.util.List<ServerCertificateSummary> serverCertificates

A list containing summary information about the server certificate included in the domain configuration.

serviceType

java.lang.String serviceType

The type of service delivered by the endpoint.

Constraints:
Allowed Values: DATA, CREDENTIAL_PROVIDER, JOBS

Class com.amazonaws.services.iot.model.DescribeEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endpointType

java.lang.String endpointType

The endpoint type. Valid endpoint types include:

• iot:Data - Returns a VeriSign signed data endpoint.

• iot:Data-ATS - Returns an ATS signed data endpoint.

• iot:CredentialProvider - Returns an IoT credentials provider API endpoint.

• iot:Jobs - Returns an IoT device management Jobs API endpoint.

We strongly recommend that customers use the newer iot:Data-ATS endpoint type to avoid issues related to the widespread distrust of Symantec certificate authorities.

Constraints:
Length: - 128
Pattern: [\s\S]*

Class com.amazonaws.services.iot.model.DescribeEndpointResult extends java.lang.Object implements Serializable

Serialized Fields

endpointAddress

java.lang.String endpointAddress

The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com.

Class com.amazonaws.services.iot.model.DescribeEventConfigurationsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.iot.model.DescribeEventConfigurationsResult extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The creation date of the event configuration.

eventConfigurations

java.util.Map<java.lang.String,Configuration> eventConfigurations

The event configurations.

lastModifiedDate

java.util.Date lastModifiedDate

The date the event configurations were last modified.

Class com.amazonaws.services.iot.model.DescribeFleetMetricRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

metricName

java.lang.String metricName

The name of the fleet metric to describe.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_\-\.]+

Class com.amazonaws.services.iot.model.DescribeFleetMetricResult extends java.lang.Object implements Serializable

Serialized Fields

aggregationField

java.lang.String aggregationField

The field to aggregate.

Constraints:
Length: 1 -

aggregationType

AggregationType aggregationType

The type of the aggregation query.

creationDate

java.util.Date creationDate

The date when the fleet metric is created.

description

java.lang.String description

The fleet metric description.

Constraints:
Length: - 1024
Pattern: [\p{Graph}\x20]*

indexName

java.lang.String indexName

The name of the index to search.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

lastModifiedDate

java.util.Date lastModifiedDate

The date when the fleet metric is last modified.

metricArn

java.lang.String metricArn

The ARN of the fleet metric to describe.

metricName

java.lang.String metricName

The name of the fleet metric to describe.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_\-\.]+

period

java.lang.Integer period

The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

Constraints:
Range: 60 - 86400

queryString

java.lang.String queryString

The search query string.

Constraints:
Length: 1 -

queryVersion

java.lang.String queryVersion

The query version.

unit

java.lang.String unit

Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

version

java.lang.Long version

The version of the fleet metric.

Class com.amazonaws.services.iot.model.DescribeIndexRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The index name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DescribeIndexResult extends java.lang.Object implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The index name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

indexStatus

java.lang.String indexStatus

The index status.

Constraints:
Allowed Values: ACTIVE, BUILDING, REBUILDING

schema

java.lang.String schema

Contains a value that specifies the type of indexing performed. Valid values are:

• REGISTRY – Your thing index contains only registry data.

• REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.

• REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.

• REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.

• MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

Class com.amazonaws.services.iot.model.DescribeJobExecutionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

executionNumber

java.lang.Long executionNumber

A string (consisting of the digits "0" through "9" which is used to specify a particular job execution on a particular device.

jobId

java.lang.String jobId

The unique identifier you assigned to this job when it was created.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

thingName

java.lang.String thingName

The name of the thing on which the job execution is running.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DescribeJobExecutionResult extends java.lang.Object implements Serializable

Serialized Fields

execution

JobExecution execution

Information about the job execution.

Class com.amazonaws.services.iot.model.DescribeJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The unique identifier you assigned to this job when it was created.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.DescribeJobResult extends java.lang.Object implements Serializable

Serialized Fields

documentSource

java.lang.String documentSource

An S3 link to the job document.

Constraints:
Length: 1 - 1350

job

Job job

Information about the job.

Class com.amazonaws.services.iot.model.DescribeJobTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobTemplateId

java.lang.String jobTemplateId

The unique identifier of the job template.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.DescribeJobTemplateResult extends java.lang.Object implements Serializable

Serialized Fields

abortConfig

AbortConfig abortConfig

The criteria that determine when and how a job abort takes place.

createdAt

java.util.Date createdAt

The time, in seconds since the epoch, when the job template was created.

description

java.lang.String description

A description of the job template.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

document

java.lang.String document

The job document.

Constraints:
Length: - 32768

documentSource

java.lang.String documentSource

An S3 link to the job document.

Constraints:
Length: 1 - 1350

jobExecutionsRetryConfig

JobExecutionsRetryConfig jobExecutionsRetryConfig

The configuration that determines how many retries are allowed for each failure type for a job.

jobExecutionsRolloutConfig

JobExecutionsRolloutConfig jobExecutionsRolloutConfig

Allows you to create a staged rollout of a job.

jobTemplateArn

java.lang.String jobTemplateArn

The ARN of the job template.

Constraints:
Length: 1 - 1600
Pattern: ^arn:[!-~]+$

jobTemplateId

java.lang.String jobTemplateId

The unique identifier of the job template.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

presignedUrlConfig

PresignedUrlConfig presignedUrlConfig

Configuration for pre-signed S3 URLs.

timeoutConfig

TimeoutConfig timeoutConfig

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Class com.amazonaws.services.iot.model.DescribeManagedJobTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

templateName

java.lang.String templateName

The unique name of a managed job template, which is required.

Constraints:
Length: 1 - 64

templateVersion

java.lang.String templateVersion

An optional parameter to specify version of a managed template. If not specified, the pre-defined default version is returned.

Constraints:
Pattern: ^[1-9]+.[0-9]+

Class com.amazonaws.services.iot.model.DescribeManagedJobTemplateResult extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

The unique description of a managed template.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

document

java.lang.String document

The document schema for a managed job template.

Constraints:
Length: - 32768

documentParameters

java.util.List<DocumentParameter> documentParameters

A map of key-value pairs that you can use as guidance to specify the inputs for creating a job from a managed template.

documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

environments

java.util.List<java.lang.String> environments

A list of environments that are supported with the managed job template.

templateArn

java.lang.String templateArn

The unique Amazon Resource Name (ARN) of the managed template.

Constraints:
Length: 1 - 1600
Pattern: ^arn:[!-~]+$

templateName

java.lang.String templateName

The unique name of a managed template, such as AWS-Reboot.

Constraints:
Length: 1 - 64

templateVersion

java.lang.String templateVersion

The version for a managed template.

Constraints:
Pattern: ^[1-9]+.[0-9]+

Class com.amazonaws.services.iot.model.DescribeMitigationActionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

actionName

java.lang.String actionName

The friendly name that uniquely identifies the mitigation action.

Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.DescribeMitigationActionResult extends java.lang.Object implements Serializable

Serialized Fields

actionArn

java.lang.String actionArn

The ARN that identifies this migration action.

actionId

java.lang.String actionId

A unique identifier for this action.

actionName

java.lang.String actionName

The friendly name that uniquely identifies the mitigation action.

Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_-]+

actionParams

MitigationActionParams actionParams

Parameters that control how the mitigation action is applied, specific to the type of mitigation action.

actionType

java.lang.String actionType

The type of mitigation action.

Constraints:
Allowed Values: UPDATE_DEVICE_CERTIFICATE, UPDATE_CA_CERTIFICATE, ADD_THINGS_TO_THING_GROUP, REPLACE_DEFAULT_POLICY_VERSION, ENABLE_IOT_LOGGING, PUBLISH_FINDING_TO_SNS

creationDate

java.util.Date creationDate

The date and time when the mitigation action was added to your Amazon Web Services accounts.

lastModifiedDate

java.util.Date lastModifiedDate

The date and time when the mitigation action was last changed.

roleArn

java.lang.String roleArn

The ARN of the IAM role used to apply this action.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.iot.model.DescribeProvisioningTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

templateName

java.lang.String templateName

The name of the provisioning template.

Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$

Class com.amazonaws.services.iot.model.DescribeProvisioningTemplateResult extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The date when the provisioning template was created.

defaultVersionId

java.lang.Integer defaultVersionId

The default fleet template version ID.

description

java.lang.String description

The description of the provisioning template.

Constraints:
Length: 0 - 500
Pattern: [^\p{C}]*

enabled

java.lang.Boolean enabled

True if the provisioning template is enabled, otherwise false.

lastModifiedDate

java.util.Date lastModifiedDate

The date when the provisioning template was last modified.

preProvisioningHook

ProvisioningHook preProvisioningHook

Gets information about a pre-provisioned hook.

provisioningRoleArn

java.lang.String provisioningRoleArn

The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.

Constraints:
Length: 20 - 2048

templateArn

java.lang.String templateArn

The ARN of the provisioning template.

templateBody

java.lang.String templateBody

The JSON formatted contents of the provisioning template.

Constraints:
Length: 0 - 10240
Pattern: [\s\S]*

templateName

java.lang.String templateName

The name of the provisioning template.

Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$

type

java.lang.String type

The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template.

Constraints:
Allowed Values: FLEET_PROVISIONING, JITP

Class com.amazonaws.services.iot.model.DescribeProvisioningTemplateVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

templateName

java.lang.String templateName

The template name.

Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$

versionId

java.lang.Integer versionId

The provisioning template version ID.

Class com.amazonaws.services.iot.model.DescribeProvisioningTemplateVersionResult extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The date when the provisioning template version was created.

isDefaultVersion

java.lang.Boolean isDefaultVersion

True if the provisioning template version is the default version.

templateBody

java.lang.String templateBody

The JSON formatted contents of the provisioning template version.

Constraints:
Length: 0 - 10240
Pattern: [\s\S]*

versionId

java.lang.Integer versionId

The provisioning template version ID.

Class com.amazonaws.services.iot.model.DescribeRoleAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

roleAlias

java.lang.String roleAlias

The role alias to describe.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

Class com.amazonaws.services.iot.model.DescribeRoleAliasResult extends java.lang.Object implements Serializable

Serialized Fields

roleAliasDescription

RoleAliasDescription roleAliasDescription

The role alias description.

Class com.amazonaws.services.iot.model.DescribeScheduledAuditRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

scheduledAuditName

java.lang.String scheduledAuditName

The name of the scheduled audit whose information you want to get.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.DescribeScheduledAuditResult extends java.lang.Object implements Serializable

Serialized Fields

dayOfMonth

java.lang.String dayOfMonth

The day of the month on which the scheduled audit takes place. This is will be 1 through 31 or LAST. If days 29-31 are specified, and the month does not have that many days, the audit takes place on the LAST day of the month.

Constraints:
Pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$

dayOfWeek

java.lang.String dayOfWeek

The day of the week on which the scheduled audit takes place, either one of SUN, MON, TUE, WED, THU, FRI, or SAT.

Constraints:
Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT

frequency

java.lang.String frequency

How often the scheduled audit takes place, either one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.

Constraints:
Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY

scheduledAuditArn

java.lang.String scheduledAuditArn

The ARN of the scheduled audit.

scheduledAuditName

java.lang.String scheduledAuditName

The name of the scheduled audit.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

targetCheckNames

java.util.List<java.lang.String> targetCheckNames

Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

Class com.amazonaws.services.iot.model.DescribeSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

securityProfileName

java.lang.String securityProfileName

The name of the security profile whose information you want to get.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DescribeSecurityProfileResult extends java.lang.Object implements Serializable

Serialized Fields

additionalMetricsToRetain

java.util.List<java.lang.String> additionalMetricsToRetain

Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.

additionalMetricsToRetainV2

java.util.List<MetricToRetain> additionalMetricsToRetainV2

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.

alertTargets

java.util.Map<java.lang.String,AlertTarget> alertTargets

Where the alerts are sent. (Alerts are always sent to the console.)

behaviors

java.util.List<Behavior> behaviors

Specifies the behaviors that, when violated by a device (thing), cause an alert.

creationDate

java.util.Date creationDate

The time the security profile was created.

lastModifiedDate

java.util.Date lastModifiedDate

The time the security profile was last modified.

securityProfileArn

java.lang.String securityProfileArn

The ARN of the security profile.

securityProfileDescription

java.lang.String securityProfileDescription

A description of the security profile (associated with the security profile when it was created or updated).

Constraints:
Length: - 1000
Pattern: [\p{Graph}\x20]*

securityProfileName

java.lang.String securityProfileName

The name of the security profile.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

version

java.lang.Long version

The version of the security profile. A new version is generated whenever the security profile is updated.

Class com.amazonaws.services.iot.model.DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamId

java.lang.String streamId

The stream ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.DescribeStreamResult extends java.lang.Object implements Serializable

Serialized Fields

streamInfo

StreamInfo streamInfo

Information about the stream.

Class com.amazonaws.services.iot.model.DescribeThingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

thingGroupName

java.lang.String thingGroupName

The name of the thing group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DescribeThingGroupResult extends java.lang.Object implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The dynamic thing group index name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

queryString

java.lang.String queryString

The dynamic thing group search query string.

Constraints:
Length: 1 -

queryVersion

java.lang.String queryVersion

The dynamic thing group query version.

status

java.lang.String status

The dynamic thing group status.

Constraints:
Allowed Values: ACTIVE, BUILDING, REBUILDING

thingGroupArn

java.lang.String thingGroupArn

The thing group ARN.

thingGroupId

java.lang.String thingGroupId

The thing group ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+

thingGroupMetadata

ThingGroupMetadata thingGroupMetadata

Thing group metadata.

thingGroupName

java.lang.String thingGroupName

The name of the thing group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingGroupProperties

ThingGroupProperties thingGroupProperties

The thing group properties.

version

java.lang.Long version

The version of the thing group.

Class com.amazonaws.services.iot.model.DescribeThingRegistrationTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskId

java.lang.String taskId

The task ID.

Constraints:
Length: - 40

Class com.amazonaws.services.iot.model.DescribeThingRegistrationTaskResult extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The task creation date.

failureCount

java.lang.Integer failureCount

The number of things that failed to be provisioned.

inputFileBucket

java.lang.String inputFileBucket

The S3 bucket that contains the input file.

Constraints:
Length: 3 - 256
Pattern: [a-zA-Z0-9._-]+

inputFileKey

java.lang.String inputFileKey

The input file key.

Constraints:
Length: 1 - 1024
Pattern: [a-zA-Z0-9!_.*'()-\/]+

lastModifiedDate

java.util.Date lastModifiedDate

The date when the task was last modified.

message

java.lang.String message

The message.

Constraints:
Length: - 2048

percentageProgress

java.lang.Integer percentageProgress

The progress of the bulk provisioning task expressed as a percentage.

Constraints:
Range: 0 - 100

roleArn

java.lang.String roleArn

The role ARN that grants access to the input file bucket.

Constraints:
Length: 20 - 2048

status

java.lang.String status

The status of the bulk thing provisioning task.

Constraints:
Allowed Values: InProgress, Completed, Failed, Cancelled, Cancelling

successCount

java.lang.Integer successCount

The number of things successfully provisioned.

taskId

java.lang.String taskId

The task ID.

Constraints:
Length: - 40

templateBody

java.lang.String templateBody

The task's template.

Constraints:
Length: 0 - 10240
Pattern: [\s\S]*

Class com.amazonaws.services.iot.model.DescribeThingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

thingName

java.lang.String thingName

The name of the thing.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DescribeThingResult extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

The thing attributes.

billingGroupName

java.lang.String billingGroupName

The name of the billing group the thing belongs to.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

defaultClientId

java.lang.String defaultClientId

The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

thingArn

java.lang.String thingArn

The ARN of the thing to describe.

thingId

java.lang.String thingId

The ID of the thing to describe.

thingName

java.lang.String thingName

The name of the thing.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingTypeName

java.lang.String thingTypeName

The thing type name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

version

java.lang.Long version

The current version of the thing record in the registry.

To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.

Class com.amazonaws.services.iot.model.DescribeThingTypeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

thingTypeName

java.lang.String thingTypeName

The name of the thing type.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DescribeThingTypeResult extends java.lang.Object implements Serializable

Serialized Fields

thingTypeArn

java.lang.String thingTypeArn

The thing type ARN.

thingTypeId

java.lang.String thingTypeId

The thing type ID.

thingTypeMetadata

ThingTypeMetadata thingTypeMetadata

The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when it was deprecated.

thingTypeName

java.lang.String thingTypeName

The name of the thing type.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingTypeProperties

ThingTypeProperties thingTypeProperties

The ThingTypeProperties contains information about the thing type including description, and a list of searchable thing attribute names.

Class com.amazonaws.services.iot.model.Destination extends java.lang.Object implements Serializable

Serialized Fields

s3Destination

S3Destination s3Destination

Describes the location in S3 of the updated firmware.

Class com.amazonaws.services.iot.model.DetachPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

java.lang.String policyName

The policy to detach.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

target

java.lang.String target

The target from which the policy will be detached.

Class com.amazonaws.services.iot.model.DetachPrincipalPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

java.lang.String policyName

The name of the policy to detach.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

principal

java.lang.String principal

The principal.

Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

Class com.amazonaws.services.iot.model.DetachSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

securityProfileName

java.lang.String securityProfileName

The security profile that is detached.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

securityProfileTargetArn

java.lang.String securityProfileTargetArn

The ARN of the thing group from which the security profile is detached.

Class com.amazonaws.services.iot.model.DetachSecurityProfileResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DetachThingPrincipalRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

principal

java.lang.String principal

If the principal is a certificate, this value must be ARN of the certificate. If the principal is an Amazon Cognito identity, this value must be the ID of the Amazon Cognito identity.

thingName

java.lang.String thingName

The name of the thing.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.DetachThingPrincipalResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.DetectMitigationActionExecution extends java.lang.Object implements Serializable

Serialized Fields

actionName

java.lang.String actionName

The friendly name that uniquely identifies the mitigation action.

Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_-]+

errorCode

java.lang.String errorCode

The error code of a mitigation action.

executionEndDate

java.util.Date executionEndDate

The date a mitigation action ended.

executionStartDate

java.util.Date executionStartDate

The date a mitigation action was started.

message

java.lang.String message

The message of a mitigation action.

Constraints:
Length: - 2048

status

java.lang.String status

The status of a mitigation action.

Constraints:
Allowed Values: IN_PROGRESS, SUCCESSFUL, FAILED, SKIPPED

taskId

java.lang.String taskId

The unique identifier of the task.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

thingName

java.lang.String thingName

The name of the thing.

Constraints:
Length: 1 - 128

violationId

java.lang.String violationId

The unique identifier of the violation.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+

Class com.amazonaws.services.iot.model.DetectMitigationActionsTaskStatistics extends java.lang.Object implements Serializable

Serialized Fields

actionsExecuted

java.lang.Long actionsExecuted

The actions that were performed.

actionsFailed

java.lang.Long actionsFailed

The actions that failed.

actionsSkipped

java.lang.Long actionsSkipped

The actions that were skipped.

Class com.amazonaws.services.iot.model.DetectMitigationActionsTaskSummary extends java.lang.Object implements Serializable

Serialized Fields

actionsDefinition

java.util.List<MitigationAction> actionsDefinition

The definition of the actions.

onlyActiveViolationsIncluded

java.lang.Boolean onlyActiveViolationsIncluded

Includes only active violations.

suppressedAlertsIncluded

java.lang.Boolean suppressedAlertsIncluded

Includes suppressed alerts.

target

DetectMitigationActionsTaskTarget target

Specifies the ML Detect findings to which the mitigation actions are applied.

taskEndTime

java.util.Date taskEndTime

The date the task ended.

taskId

java.lang.String taskId

The unique identifier of the task.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

taskStartTime

java.util.Date taskStartTime

The date the task started.

taskStatistics

DetectMitigationActionsTaskStatistics taskStatistics

The statistics of a mitigation action task.

taskStatus

java.lang.String taskStatus

The status of the task.

Constraints:
Allowed Values: IN_PROGRESS, SUCCESSFUL, FAILED, CANCELED

violationEventOccurrenceRange

ViolationEventOccurrenceRange violationEventOccurrenceRange

Specifies the time period of which violation events occurred between.

Class com.amazonaws.services.iot.model.DetectMitigationActionsTaskTarget extends java.lang.Object implements Serializable

Serialized Fields

behaviorName

java.lang.String behaviorName

The name of the behavior.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

securityProfileName

java.lang.String securityProfileName

The name of the security profile.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

violationIds

java.util.List<java.lang.String> violationIds

The unique identifiers of the violations.

Class com.amazonaws.services.iot.model.DisableTopicRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleName

java.lang.String ruleName

The name of the rule to disable.

Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$

Class com.amazonaws.services.iot.model.DocumentParameter extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

Description of the map field containing the patterns that need to be replaced in a managed template job document schema.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

example

java.lang.String example

An example illustrating a pattern that need to be replaced in a managed template job document schema.

Constraints:
Pattern: [^\p{C}]+

key

java.lang.String key

Key of the map field containing the patterns that need to be replaced in a managed template job document schema.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

optional

java.lang.Boolean optional

Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.

regex

java.lang.String regex

A regular expression of the patterns that need to be replaced in a managed template job document schema.

Class com.amazonaws.services.iot.model.DomainConfigurationSummary extends java.lang.Object implements Serializable

Serialized Fields

domainConfigurationArn

java.lang.String domainConfigurationArn

The ARN of the domain configuration.

domainConfigurationName

java.lang.String domainConfigurationName

The name of the domain configuration. This value must be unique to a region.

Constraints:
Length: 1 - 128
Pattern: [\w.:-]+

serviceType

java.lang.String serviceType

The type of service delivered by the endpoint.

Constraints:
Allowed Values: DATA, CREDENTIAL_PROVIDER, JOBS

Class com.amazonaws.services.iot.model.DynamoDBAction extends java.lang.Object implements Serializable

Serialized Fields

hashKeyField

java.lang.String hashKeyField

The hash key name.

hashKeyType

java.lang.String hashKeyType

The hash key type. Valid values are "STRING" or "NUMBER"

Constraints:
Allowed Values: STRING, NUMBER

hashKeyValue

java.lang.String hashKeyValue

The hash key value.

operation

java.lang.String operation

The type of operation to be performed. This follows the substitution template, so it can be ${operation}, but the substitution must result in one of the following: INSERT, UPDATE, or DELETE.

payloadField

java.lang.String payloadField

The action payload. This name can be customized.

rangeKeyField

java.lang.String rangeKeyField

The range key name.

rangeKeyType

java.lang.String rangeKeyType

The range key type. Valid values are "STRING" or "NUMBER"

Constraints:
Allowed Values: STRING, NUMBER

rangeKeyValue

java.lang.String rangeKeyValue

The range key value.

roleArn

java.lang.String roleArn

The ARN of the IAM role that grants access to the DynamoDB table.

tableName

java.lang.String tableName

The name of the DynamoDB table.

Class com.amazonaws.services.iot.model.DynamoDBv2Action extends java.lang.Object implements Serializable

Serialized Fields

putItem

PutItemInput putItem

Specifies the DynamoDB table to which the message data will be written. For example:

{ "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } }

Each attribute in the message payload will be written to a separate column in the DynamoDB database.

roleArn

java.lang.String roleArn

The ARN of the IAM role that grants access to the DynamoDB table.

Class com.amazonaws.services.iot.model.EffectivePolicy extends java.lang.Object implements Serializable

Serialized Fields

policyArn

java.lang.String policyArn

The policy ARN.

policyDocument

java.lang.String policyDocument

The IAM policy document.

Constraints:
Length: 0 - 404600
Pattern: [\s\S]*

policyName

java.lang.String policyName

The policy name.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Class com.amazonaws.services.iot.model.ElasticsearchAction extends java.lang.Object implements Serializable

Serialized Fields

endpoint

java.lang.String endpoint

The endpoint of your OpenSearch domain.

Constraints:
Pattern: https?://.*

id

java.lang.String id

The unique identifier for the document you are storing.

index

java.lang.String index

The index where you want to store your data.

roleArn

java.lang.String roleArn

The IAM role ARN that has access to OpenSearch.

type

java.lang.String type

The type of document you are storing.

Class com.amazonaws.services.iot.model.EnableIoTLoggingParams extends java.lang.Object implements Serializable

Serialized Fields

logLevel

java.lang.String logLevel

Specifies the type of information to be logged.

Constraints:
Allowed Values: DEBUG, INFO, ERROR, WARN, DISABLED

roleArnForLogging

java.lang.String roleArnForLogging

The Amazon Resource Name (ARN) of the IAM role used for logging.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.iot.model.EnableTopicRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleName

java.lang.String ruleName

The name of the topic rule to enable.

Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$

Class com.amazonaws.services.iot.model.ErrorInfo extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.String code

The error code.

message

java.lang.String message

The error message.

Class com.amazonaws.services.iot.model.ExplicitDeny extends java.lang.Object implements Serializable

Serialized Fields

policies

java.util.List<Policy> policies

The policies that denied the authorization.

Class com.amazonaws.services.iot.model.ExponentialRolloutRate extends java.lang.Object implements Serializable

Serialized Fields

baseRatePerMinute

java.lang.Integer baseRatePerMinute

The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

Constraints:
Range: 1 - 1000

incrementFactor

java.lang.Double incrementFactor

The exponential factor to increase the rate of rollout for a job.

Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

Constraints:
Range: 1.1 - 5.0

rateIncreaseCriteria

RateIncreaseCriteria rateIncreaseCriteria

The criteria to initiate the increase in rate of rollout for a job.

Class com.amazonaws.services.iot.model.Field extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the field.

type

java.lang.String type

The data type of the field.

Constraints:
Allowed Values: Number, String, Boolean

Class com.amazonaws.services.iot.model.FileLocation extends java.lang.Object implements Serializable

Serialized Fields

s3Location

S3Location s3Location

The location of the updated firmware in S3.

stream

Stream stream

The stream that contains the OTA update.

Class com.amazonaws.services.iot.model.FirehoseAction extends java.lang.Object implements Serializable

Serialized Fields

batchMode

java.lang.Boolean batchMode

Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch . The default value is false.

When batchMode is true and the rule's SQL statement evaluates to an Array, each Array element forms one record in the PutRecordBatch request. The resulting array can't have more than 500 records.

deliveryStreamName

java.lang.String deliveryStreamName

The delivery stream name.

roleArn

java.lang.String roleArn

The IAM role that grants access to the Amazon Kinesis Firehose stream.

separator

java.lang.String separator

A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).

Constraints:
Pattern: ([\n\t])|(\r\n)|(,)

Class com.amazonaws.services.iot.model.FleetMetricNameAndArn extends java.lang.Object implements Serializable

Serialized Fields

metricArn

java.lang.String metricArn

The fleet metric ARN.

metricName

java.lang.String metricName

The fleet metric name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_\-\.]+

Class com.amazonaws.services.iot.model.GetBehaviorModelTrainingSummariesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time. The default is 25.

Constraints:
Range: 1 - 10

nextToken

java.lang.String nextToken

The token for the next set of results.

securityProfileName

java.lang.String securityProfileName

The name of the security profile.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.GetBehaviorModelTrainingSummariesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

summaries

java.util.List<BehaviorModelTrainingSummary> summaries

A list of all ML Detect behaviors and their model status for a given Security Profile.

Class com.amazonaws.services.iot.model.GetBucketsAggregationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aggregationField

java.lang.String aggregationField

The aggregation field.

Constraints:
Length: 1 -

bucketsAggregationType

BucketsAggregationType bucketsAggregationType

The basic control of the response shape and the bucket aggregation type to perform.

indexName

java.lang.String indexName

The name of the index to search.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

queryString

java.lang.String queryString

The search query string.

Constraints:
Length: 1 -

queryVersion

java.lang.String queryVersion

The version of the query.

Class com.amazonaws.services.iot.model.GetBucketsAggregationResult extends java.lang.Object implements Serializable

Serialized Fields

buckets

java.util.List<Bucket> buckets

The main part of the response with a list of buckets. Each bucket contains a keyValue and a count.

keyValue: The aggregation field value counted for the particular bucket.

count: The number of documents that have that value.

totalCount

java.lang.Integer totalCount

The total number of things that fit the query string criteria.

Class com.amazonaws.services.iot.model.GetCardinalityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aggregationField

java.lang.String aggregationField

The field to aggregate.

Constraints:
Length: 1 -

indexName

java.lang.String indexName

The name of the index to search.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

queryString

java.lang.String queryString

The search query string.

Constraints:
Length: 1 -

queryVersion

java.lang.String queryVersion

The query version.

Class com.amazonaws.services.iot.model.GetCardinalityResult extends java.lang.Object implements Serializable

Serialized Fields

cardinality

java.lang.Integer cardinality

The approximate count of unique values that match the query.

Class com.amazonaws.services.iot.model.GetEffectivePoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cognitoIdentityPoolId

java.lang.String cognitoIdentityPoolId

The Cognito identity pool ID.

principal

java.lang.String principal

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

thingName

java.lang.String thingName

The thing name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.GetEffectivePoliciesResult extends java.lang.Object implements Serializable

Serialized Fields

effectivePolicies

java.util.List<EffectivePolicy> effectivePolicies

The effective policies.

Class com.amazonaws.services.iot.model.GetIndexingConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.iot.model.GetIndexingConfigurationResult extends java.lang.Object implements Serializable

Serialized Fields

thingGroupIndexingConfiguration

ThingGroupIndexingConfiguration thingGroupIndexingConfiguration

The index configuration.

thingIndexingConfiguration

ThingIndexingConfiguration thingIndexingConfiguration

Thing indexing configuration.

Class com.amazonaws.services.iot.model.GetJobDocumentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The unique identifier you assigned to this job when it was created.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.GetJobDocumentResult extends java.lang.Object implements Serializable

Serialized Fields

document

java.lang.String document

The job document content.

Constraints:
Length: - 32768

Class com.amazonaws.services.iot.model.GetLoggingOptionsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.iot.model.GetLoggingOptionsResult extends java.lang.Object implements Serializable

Serialized Fields

logLevel

java.lang.String logLevel

The logging level.

Constraints:
Allowed Values: DEBUG, INFO, ERROR, WARN, DISABLED

roleArn

java.lang.String roleArn

The ARN of the IAM role that grants access.

Class com.amazonaws.services.iot.model.GetOTAUpdateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

otaUpdateId

java.lang.String otaUpdateId

The OTA update ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.GetOTAUpdateResult extends java.lang.Object implements Serializable

Serialized Fields

otaUpdateInfo

OTAUpdateInfo otaUpdateInfo

The OTA update info.

Class com.amazonaws.services.iot.model.GetPercentilesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aggregationField

java.lang.String aggregationField

The field to aggregate.

Constraints:
Length: 1 -

indexName

java.lang.String indexName

The name of the index to search.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

percents

java.util.List<java.lang.Double> percents

The percentile groups returned.

queryString

java.lang.String queryString

The search query string.

Constraints:
Length: 1 -

queryVersion

java.lang.String queryVersion

The query version.

Class com.amazonaws.services.iot.model.GetPercentilesResult extends java.lang.Object implements Serializable

Serialized Fields

percentiles

java.util.List<PercentPair> percentiles

The percentile values of the aggregated fields.

Class com.amazonaws.services.iot.model.GetPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

java.lang.String policyName

The name of the policy.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Class com.amazonaws.services.iot.model.GetPolicyResult extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The date the policy was created.

defaultVersionId

java.lang.String defaultVersionId

The default policy version ID.

Constraints:
Pattern: [0-9]+

generationId

java.lang.String generationId

The generation ID of the policy.

lastModifiedDate

java.util.Date lastModifiedDate

The date the policy was last modified.

policyArn

java.lang.String policyArn

The policy ARN.

policyDocument

java.lang.String policyDocument

The JSON document that describes the policy.

Constraints:
Length: 0 - 404600
Pattern: [\s\S]*

policyName

java.lang.String policyName

The policy name.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Class com.amazonaws.services.iot.model.GetPolicyVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

java.lang.String policyName

The name of the policy.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

policyVersionId

java.lang.String policyVersionId

The policy version ID.

Constraints:
Pattern: [0-9]+

Class com.amazonaws.services.iot.model.GetPolicyVersionResult extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The date the policy was created.

generationId

java.lang.String generationId

The generation ID of the policy version.

isDefaultVersion

java.lang.Boolean isDefaultVersion

Specifies whether the policy version is the default.

lastModifiedDate

java.util.Date lastModifiedDate

The date the policy was last modified.

policyArn

java.lang.String policyArn

The policy ARN.

policyDocument

java.lang.String policyDocument

The JSON document that describes the policy.

Constraints:
Length: 0 - 404600
Pattern: [\s\S]*

policyName

java.lang.String policyName

The policy name.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

policyVersionId

java.lang.String policyVersionId

The policy version ID.

Constraints:
Pattern: [0-9]+

Class com.amazonaws.services.iot.model.GetRegistrationCodeRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.iot.model.GetRegistrationCodeResult extends java.lang.Object implements Serializable

Serialized Fields

registrationCode

java.lang.String registrationCode

The CA certificate registration code.

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

Class com.amazonaws.services.iot.model.GetStatisticsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aggregationField

java.lang.String aggregationField

The aggregation field name.

Constraints:
Length: 1 -

indexName

java.lang.String indexName

The name of the index to search. The default value is AWS_Things.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

queryString

java.lang.String queryString

The query used to search. You can specify "*" for the query string to get the count of all indexed things in your Amazon Web Services account.

Constraints:
Length: 1 -

queryVersion

java.lang.String queryVersion

The version of the query used to search.

Class com.amazonaws.services.iot.model.GetStatisticsResult extends java.lang.Object implements Serializable

Serialized Fields

statistics

Statistics statistics

The statistics returned by the Fleet Indexing service based on the query and aggregation field.

Class com.amazonaws.services.iot.model.GetTopicRuleDestinationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

java.lang.String arn

The ARN of the topic rule destination.

Class com.amazonaws.services.iot.model.GetTopicRuleDestinationResult extends java.lang.Object implements Serializable

Serialized Fields

topicRuleDestination

TopicRuleDestination topicRuleDestination

The topic rule destination.

Class com.amazonaws.services.iot.model.GetTopicRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleName

java.lang.String ruleName

The name of the rule.

Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$

Class com.amazonaws.services.iot.model.GetTopicRuleResult extends java.lang.Object implements Serializable

Serialized Fields

rule

TopicRule rule

The rule.

ruleArn

java.lang.String ruleArn

The rule ARN.

Class com.amazonaws.services.iot.model.GetV2LoggingOptionsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.iot.model.GetV2LoggingOptionsResult extends java.lang.Object implements Serializable

Serialized Fields

defaultLogLevel

java.lang.String defaultLogLevel

The default log level.

Constraints:
Allowed Values: DEBUG, INFO, ERROR, WARN, DISABLED

disableAllLogs

java.lang.Boolean disableAllLogs

Disables all logs.

roleArn

java.lang.String roleArn

The IAM role ARN IoT uses to write to your CloudWatch logs.

Class com.amazonaws.services.iot.model.GroupNameAndArn extends java.lang.Object implements Serializable

Serialized Fields

groupArn

java.lang.String groupArn

The group ARN.

groupName

java.lang.String groupName

The group name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.HttpAction extends java.lang.Object implements Serializable

Serialized Fields

auth

HttpAuthorization auth

The authentication method to use when sending data to an HTTPS endpoint.

confirmationUrl

java.lang.String confirmationUrl

The URL to which IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.

Constraints:
Length: - 2000

headers

java.util.List<HttpActionHeader> headers

The HTTP headers to send with the message data.

url

java.lang.String url

The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl. If this is a new destination, a new TopicRuleDestination is created if possible.

Constraints:
Length: - 2000

Class com.amazonaws.services.iot.model.HttpActionHeader extends java.lang.Object implements Serializable

Serialized Fields

key

java.lang.String key

The HTTP header key.

Constraints:
Length: 1 - 256

value

java.lang.String value

The HTTP header value. Substitution templates are supported.

Class com.amazonaws.services.iot.model.HttpAuthorization extends java.lang.Object implements Serializable

Serialized Fields

sigv4

SigV4Authorization sigv4

Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process.

Class com.amazonaws.services.iot.model.HttpContext extends java.lang.Object implements Serializable

Serialized Fields

headers

java.util.Map<java.lang.String,java.lang.String> headers

The header keys and values in an HTTP authorization request.

queryString

java.lang.String queryString

The query string keys and values in an HTTP authorization request.

Constraints:
Length: 1 - 4096
Pattern: [\s\S]*

Class com.amazonaws.services.iot.model.HttpUrlDestinationConfiguration extends java.lang.Object implements Serializable

Serialized Fields

confirmationUrl

java.lang.String confirmationUrl

The URL IoT uses to confirm ownership of or access to the topic rule destination URL.

Constraints:
Length: - 2000

Class com.amazonaws.services.iot.model.HttpUrlDestinationProperties extends java.lang.Object implements Serializable

Serialized Fields

confirmationUrl

java.lang.String confirmationUrl

The URL used to confirm the HTTP topic rule destination URL.

Constraints:
Length: - 2000

Class com.amazonaws.services.iot.model.HttpUrlDestinationSummary extends java.lang.Object implements Serializable

Serialized Fields

confirmationUrl

java.lang.String confirmationUrl

The URL used to confirm ownership of or access to the HTTP topic rule destination URL.

Constraints:
Length: - 2000

Class com.amazonaws.services.iot.model.ImplicitDeny extends java.lang.Object implements Serializable

Serialized Fields

policies

java.util.List<Policy> policies

Policies that don't contain a matching allow or deny statement for the specified action on the specified resource.

Class com.amazonaws.services.iot.model.IndexingFilter extends java.lang.Object implements Serializable

Serialized Fields

namedShadowNames

java.util.List<java.lang.String> namedShadowNames

The shadow names that you select to index. The default maximum number of shadow names for indexing is 10. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.

Class com.amazonaws.services.iot.model.IndexNotReadyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.InternalException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.InternalFailureException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.InternalServerException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.InvalidAggregationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.InvalidQueryException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.InvalidResponseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.InvalidStateTransitionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.IotAnalyticsAction extends java.lang.Object implements Serializable

Serialized Fields

batchMode

java.lang.Boolean batchMode

Whether to process the action as a batch. The default value is false.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage to the IoT Analytics channel. The resulting array can't have more than 100 messages.

channelArn

java.lang.String channelArn

(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

channelName

java.lang.String channelName

The name of the IoT Analytics channel to which message data will be sent.

roleArn

java.lang.String roleArn

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

Class com.amazonaws.services.iot.model.IotEventsAction extends java.lang.Object implements Serializable

Serialized Fields

batchMode

java.lang.Boolean batchMode

Whether to process the event actions as a batch. The default value is false.

When batchMode is true, you can't specify a messageId.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to IoT Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

inputName

java.lang.String inputName

The name of the IoT Events input.

Constraints:
Length: 1 - 128

messageId

java.lang.String messageId

The ID of the message. The default messageId is a new UUID value.

When batchMode is true, you can't specify a messageId--a new UUID value will be assigned.

Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an IoT Events detector.

Constraints:
Length: - 128

roleArn

java.lang.String roleArn

The ARN of the role that grants IoT permission to send an input to an IoT Events detector. ("Action":"iotevents:BatchPutMessage").

Class com.amazonaws.services.iot.model.IotSiteWiseAction extends java.lang.Object implements Serializable

Serialized Fields

putAssetPropertyValueEntries

java.util.List<PutAssetPropertyValueEntry> putAssetPropertyValueEntries

A list of asset property value entries.

roleArn

java.lang.String roleArn

The ARN of the role that grants IoT permission to send an asset property value to IoT SiteWise. ( "Action": "iotsitewise:BatchPutAssetPropertyValue"). The trust policy can restrict access to specific asset hierarchy paths.

Class com.amazonaws.services.iot.model.Job extends java.lang.Object implements Serializable

Serialized Fields

abortConfig

AbortConfig abortConfig

Configuration for criteria to abort the job.

comment

java.lang.String comment

If the job was updated, describes the reason for the update.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

completedAt

java.util.Date completedAt

The time, in seconds since the epoch, when the job was completed.

createdAt

java.util.Date createdAt

The time, in seconds since the epoch, when the job was created.

description

java.lang.String description

A short text description of the job.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

documentParameters

java.util.Map<java.lang.String,java.lang.String> documentParameters

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

forceCanceled

java.lang.Boolean forceCanceled

Will be true if the job was canceled with the optional force parameter set to true.

isConcurrent

java.lang.Boolean isConcurrent

Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.

jobArn

java.lang.String jobArn

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

jobExecutionsRetryConfig

JobExecutionsRetryConfig jobExecutionsRetryConfig

The configuration for the criteria to retry the job.

jobExecutionsRolloutConfig

JobExecutionsRolloutConfig jobExecutionsRolloutConfig

Allows you to create a staged rollout of a job.

jobId

java.lang.String jobId

The unique identifier you assigned to this job when it was created.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

jobProcessDetails

JobProcessDetails jobProcessDetails

Details about the job process.

jobTemplateArn

java.lang.String jobTemplateArn

The ARN of the job template used to create the job.

Constraints:
Length: 1 - 1600
Pattern: ^arn:[!-~]+$

lastUpdatedAt

java.util.Date lastUpdatedAt

The time, in seconds since the epoch, when the job was last updated.

namespaceId

java.lang.String namespaceId

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

presignedUrlConfig

PresignedUrlConfig presignedUrlConfig

Configuration for pre-signed S3 URLs.

reasonCode

java.lang.String reasonCode

If the job was updated, provides the reason code for the update.

Constraints:
Length: - 128
Pattern: [\p{Upper}\p{Digit}_]+

status

java.lang.String status

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Constraints:
Allowed Values: IN_PROGRESS, CANCELED, COMPLETED, DELETION_IN_PROGRESS

targets

java.util.List<java.lang.String> targets

A list of IoT things and thing groups to which the job should be sent.

targetSelection

java.lang.String targetSelection

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT

timeoutConfig

TimeoutConfig timeoutConfig

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Class com.amazonaws.services.iot.model.JobExecution extends java.lang.Object implements Serializable

Serialized Fields

approximateSecondsBeforeTimedOut

java.lang.Long approximateSecondsBeforeTimedOut

The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.

executionNumber

java.lang.Long executionNumber

A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.

forceCanceled

java.lang.Boolean forceCanceled

Will be true if the job execution was canceled with the optional force parameter set to true.

jobId

java.lang.String jobId

The unique identifier you assigned to the job when it was created.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

lastUpdatedAt

java.util.Date lastUpdatedAt

The time, in seconds since the epoch, when the job execution was last updated.

queuedAt

java.util.Date queuedAt

The time, in seconds since the epoch, when the job execution was queued.

startedAt

java.util.Date startedAt

The time, in seconds since the epoch, when the job execution started.

status

java.lang.String status

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, TIMED_OUT, REJECTED, REMOVED, CANCELED

statusDetails

JobExecutionStatusDetails statusDetails

A collection of name/value pairs that describe the status of the job execution.

thingArn

java.lang.String thingArn

The ARN of the thing on which the job execution is running.

versionNumber

java.lang.Long versionNumber

The version of the job execution. Job execution versions are incremented each time they are updated by a device.

Class com.amazonaws.services.iot.model.JobExecutionsRetryConfig extends java.lang.Object implements Serializable

Serialized Fields

criteriaList

java.util.List<RetryCriteria> criteriaList

The list of criteria that determines how many retries are allowed for each failure type for a job.

Class com.amazonaws.services.iot.model.JobExecutionsRolloutConfig extends java.lang.Object implements Serializable

Serialized Fields

exponentialRate

ExponentialRolloutRate exponentialRate

The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.

maximumPerMinute

java.lang.Integer maximumPerMinute

The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.

Constraints:
Range: 1 -

Class com.amazonaws.services.iot.model.JobExecutionStatusDetails extends java.lang.Object implements Serializable

Serialized Fields

detailsMap

java.util.Map<java.lang.String,java.lang.String> detailsMap

The job execution status.

Class com.amazonaws.services.iot.model.JobExecutionSummary extends java.lang.Object implements Serializable

Serialized Fields

executionNumber

java.lang.Long executionNumber

A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used later in commands which return or update job execution information.

lastUpdatedAt

java.util.Date lastUpdatedAt

The time, in seconds since the epoch, when the job execution was last updated.

queuedAt

java.util.Date queuedAt

The time, in seconds since the epoch, when the job execution was queued.

retryAttempt

java.lang.Integer retryAttempt

The number that indicates how many retry attempts have been completed for this job on this device.

startedAt

java.util.Date startedAt

The time, in seconds since the epoch, when the job execution started.

status

java.lang.String status

The status of the job execution.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, TIMED_OUT, REJECTED, REMOVED, CANCELED

Class com.amazonaws.services.iot.model.JobExecutionSummaryForJob extends java.lang.Object implements Serializable

Serialized Fields

jobExecutionSummary

JobExecutionSummary jobExecutionSummary

Contains a subset of information about a job execution.

thingArn

java.lang.String thingArn

The ARN of the thing on which the job execution is running.

Class com.amazonaws.services.iot.model.JobExecutionSummaryForThing extends java.lang.Object implements Serializable

Serialized Fields

jobExecutionSummary

JobExecutionSummary jobExecutionSummary

Contains a subset of information about a job execution.

jobId

java.lang.String jobId

The unique identifier you assigned to this job when it was created.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.JobProcessDetails extends java.lang.Object implements Serializable

Serialized Fields

numberOfCanceledThings

java.lang.Integer numberOfCanceledThings

The number of things that cancelled the job.

numberOfFailedThings

java.lang.Integer numberOfFailedThings

The number of things that failed executing the job.

numberOfInProgressThings

java.lang.Integer numberOfInProgressThings

The number of things currently executing the job.

numberOfQueuedThings

java.lang.Integer numberOfQueuedThings

The number of things that are awaiting execution of the job.

numberOfRejectedThings

java.lang.Integer numberOfRejectedThings

The number of things that rejected the job.

numberOfRemovedThings

java.lang.Integer numberOfRemovedThings

The number of things that are no longer scheduled to execute the job because they have been deleted or have been removed from the group that was a target of the job.

numberOfSucceededThings

java.lang.Integer numberOfSucceededThings

The number of things which successfully completed the job.

numberOfTimedOutThings

java.lang.Integer numberOfTimedOutThings

The number of things whose job execution status is TIMED_OUT .

processingTargets

java.util.List<java.lang.String> processingTargets

The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices.

Class com.amazonaws.services.iot.model.JobSummary extends java.lang.Object implements Serializable

Serialized Fields

completedAt

java.util.Date completedAt

The time, in seconds since the epoch, when the job completed.

createdAt

java.util.Date createdAt

The time, in seconds since the epoch, when the job was created.

isConcurrent

java.lang.Boolean isConcurrent

Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.

jobArn

java.lang.String jobArn

The job ARN.

jobId

java.lang.String jobId

The unique identifier you assigned to this job when it was created.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

lastUpdatedAt

java.util.Date lastUpdatedAt

The time, in seconds since the epoch, when the job was last updated.

status

java.lang.String status

The job summary status.

Constraints:
Allowed Values: IN_PROGRESS, CANCELED, COMPLETED, DELETION_IN_PROGRESS

targetSelection

java.lang.String targetSelection

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT

thingGroupId

java.lang.String thingGroupId

The ID of the thing group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+

Class com.amazonaws.services.iot.model.JobTemplateSummary extends java.lang.Object implements Serializable

Serialized Fields

createdAt

java.util.Date createdAt

The time, in seconds since the epoch, when the job template was created.

description

java.lang.String description

A description of the job template.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

jobTemplateArn

java.lang.String jobTemplateArn

The ARN of the job template.

Constraints:
Length: 1 - 1600
Pattern: ^arn:[!-~]+$

jobTemplateId

java.lang.String jobTemplateId

The unique identifier of the job template.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.KafkaAction extends java.lang.Object implements Serializable

Serialized Fields

clientProperties

java.util.Map<java.lang.String,java.lang.String> clientProperties

Properties of the Apache Kafka producer client.

destinationArn

java.lang.String destinationArn

The ARN of Kafka action's VPC TopicRuleDestination.

key

java.lang.String key

The Kafka message key.

partition

java.lang.String partition

The Kafka message partition.

topic

java.lang.String topic

The Kafka topic for messages to be sent to the Kafka broker.

Class com.amazonaws.services.iot.model.KeyPair extends java.lang.Object implements Serializable

Serialized Fields

privateKey

java.lang.String privateKey

The private key.

Constraints:
Length: 1 -

publicKey

java.lang.String publicKey

The public key.

Constraints:
Length: 1 -

Class com.amazonaws.services.iot.model.KinesisAction extends java.lang.Object implements Serializable

Serialized Fields

partitionKey

java.lang.String partitionKey

The partition key.

roleArn

java.lang.String roleArn

The ARN of the IAM role that grants access to the Amazon Kinesis stream.

streamName

java.lang.String streamName

The name of the Amazon Kinesis stream.

Class com.amazonaws.services.iot.model.LambdaAction extends java.lang.Object implements Serializable

Serialized Fields

functionArn

java.lang.String functionArn

The ARN of the Lambda function.

Class com.amazonaws.services.iot.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.ListActiveViolationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

behaviorCriteriaType

java.lang.String behaviorCriteriaType

The criteria for a behavior.

Constraints:
Allowed Values: STATIC, STATISTICAL, MACHINE_LEARNING

listSuppressedAlerts

java.lang.Boolean listSuppressedAlerts

A list of all suppressed alerts.

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token for the next set of results.

securityProfileName

java.lang.String securityProfileName

The name of the Device Defender security profile for which violations are listed.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingName

java.lang.String thingName

The name of the thing whose active violations are listed.

Constraints:
Length: 1 - 128

verificationState

java.lang.String verificationState

The verification state of the violation (detect alarm).

Constraints:
Allowed Values: FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN

Class com.amazonaws.services.iot.model.ListActiveViolationsResult extends java.lang.Object implements Serializable

Serialized Fields

activeViolations

java.util.List<ActiveViolation> activeViolations

The list of active violations.

nextToken

java.lang.String nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

Class com.amazonaws.services.iot.model.ListAttachedPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

marker

java.lang.String marker

The token to retrieve the next set of results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

pageSize

java.lang.Integer pageSize

The maximum number of results to be returned per request.

Constraints:
Range: 1 - 250

recursive

java.lang.Boolean recursive

When true, recursively list attached policies.

target

java.lang.String target

The group or principal for which the policies will be listed. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

Class com.amazonaws.services.iot.model.ListAttachedPoliciesResult extends java.lang.Object implements Serializable

Serialized Fields

nextMarker

java.lang.String nextMarker

The token to retrieve the next set of results, or ``null`` if there are no more results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

policies

java.util.List<Policy> policies

The policies.

Class com.amazonaws.services.iot.model.ListAuditFindingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

checkName

java.lang.String checkName

A filter to limit results to the findings for the specified audit check.

endTime

java.util.Date endTime

A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.

listSuppressedFindings

java.lang.Boolean listSuppressedFindings

Boolean flag indicating whether only the suppressed findings or the unsuppressed findings should be listed. If this parameter isn't provided, the response will list both suppressed and unsuppressed findings.

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time. The default is 25.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token for the next set of results.

resourceIdentifier

ResourceIdentifier resourceIdentifier

Information identifying the noncompliant resource.

startTime

java.util.Date startTime

A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.

taskId

java.lang.String taskId

A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both.

Constraints:
Length: 1 - 40
Pattern: [a-zA-Z0-9\-]+

Class com.amazonaws.services.iot.model.ListAuditFindingsResult extends java.lang.Object implements Serializable

Serialized Fields

findings

java.util.List<AuditFinding> findings

The findings (results) of the audit.

nextToken

java.lang.String nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

Class com.amazonaws.services.iot.model.ListAuditMitigationActionsExecutionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

actionStatus

java.lang.String actionStatus

Specify this filter to limit results to those with a specific status.

Constraints:
Allowed Values: IN_PROGRESS, COMPLETED, FAILED, CANCELED, SKIPPED, PENDING

findingId

java.lang.String findingId

Specify this filter to limit results to those that were applied to a specific audit finding.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time. The default is 25.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token for the next set of results.

taskId

java.lang.String taskId

Specify this filter to limit results to actions for a specific audit mitigation actions task.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.ListAuditMitigationActionsExecutionsResult extends java.lang.Object implements Serializable

Serialized Fields

actionsExecutions

java.util.List<AuditMitigationActionExecutionMetadata> actionsExecutions

A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.

nextToken

java.lang.String nextToken

The token for the next set of results.

Class com.amazonaws.services.iot.model.ListAuditMitigationActionsTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

auditTaskId

java.lang.String auditTaskId

Specify this filter to limit results to tasks that were applied to results for a specific audit.

Constraints:
Length: 1 - 40
Pattern: [a-zA-Z0-9\-]+

endTime

java.util.Date endTime

Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.

findingId

java.lang.String findingId

Specify this filter to limit results to tasks that were applied to a specific audit finding.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time. The default is 25.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token for the next set of results.

startTime

java.util.Date startTime

Specify this filter to limit results to tasks that began on or after a specific date and time.

taskStatus

java.lang.String taskStatus

Specify this filter to limit results to tasks that are in a specific state.

Constraints:
Allowed Values: IN_PROGRESS, COMPLETED, FAILED, CANCELED

Class com.amazonaws.services.iot.model.ListAuditMitigationActionsTasksResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token for the next set of results.

tasks

java.util.List<AuditMitigationActionsTaskMetadata> tasks

The collection of audit mitigation tasks that matched the filter criteria.

Class com.amazonaws.services.iot.model.ListAuditSuppressionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ascendingOrder

java.lang.Boolean ascendingOrder

Determines whether suppressions are listed in ascending order by expiration date or not. If parameter isn't provided, ascendingOrder=true.

checkName

java.lang.String checkName

An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time. The default is 25.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token for the next set of results.

resourceIdentifier

ResourceIdentifier resourceIdentifier

Information that identifies the noncompliant resource.

Class com.amazonaws.services.iot.model.ListAuditSuppressionsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

suppressions

java.util.List<AuditSuppression> suppressions

List of audit suppressions.

Class com.amazonaws.services.iot.model.ListAuditTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endTime

java.util.Date endTime

The end of the time period.

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time. The default is 25.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token for the next set of results.

startTime

java.util.Date startTime

The beginning of the time period. Audit information is retained for a limited time (90 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".

taskStatus

java.lang.String taskStatus

A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

Constraints:
Allowed Values: IN_PROGRESS, COMPLETED, FAILED, CANCELED

taskType

java.lang.String taskType

A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".

Constraints:
Allowed Values: ON_DEMAND_AUDIT_TASK, SCHEDULED_AUDIT_TASK

Class com.amazonaws.services.iot.model.ListAuditTasksResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

tasks

java.util.List<AuditTaskMetadata> tasks

The audits that were performed during the specified time period.

Class com.amazonaws.services.iot.model.ListAuthorizersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ascendingOrder

java.lang.Boolean ascendingOrder

Return the list of authorizers in ascending alphabetical order.

marker

java.lang.String marker

A marker used to get the next set of results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

pageSize

java.lang.Integer pageSize

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

status

java.lang.String status

The status of the list authorizers request.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Class com.amazonaws.services.iot.model.ListAuthorizersResult extends java.lang.Object implements Serializable

Serialized Fields

authorizers

java.util.List<AuthorizerSummary> authorizers

The authorizers.

nextMarker

java.lang.String nextMarker

A marker used to get the next set of results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

Class com.amazonaws.services.iot.model.ListBillingGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return per request.

Constraints:
Range: 1 - 250

namePrefixFilter

java.lang.String namePrefixFilter

Limit the results to billing groups whose names have the given prefix.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

nextToken

java.lang.String nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Class com.amazonaws.services.iot.model.ListBillingGroupsResult extends java.lang.Object implements Serializable

Serialized Fields

billingGroups

java.util.List<GroupNameAndArn> billingGroups

The list of billing groups.

nextToken

java.lang.String nextToken

The token to use to get the next set of results, or null if there are no additional results.

Class com.amazonaws.services.iot.model.ListCACertificatesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ascendingOrder

java.lang.Boolean ascendingOrder

Determines the order of the results.

marker

java.lang.String marker

The marker for the next set of results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

pageSize

java.lang.Integer pageSize

The result page size.

Constraints:
Range: 1 - 250

templateName

java.lang.String templateName

The name of the provisioning template.

Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$

Class com.amazonaws.services.iot.model.ListCACertificatesResult extends java.lang.Object implements Serializable

Serialized Fields

certificates

java.util.List<CACertificate> certificates

The CA certificates registered in your Amazon Web Services account.

nextMarker

java.lang.String nextMarker

The current position within the list of CA certificates.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

Class com.amazonaws.services.iot.model.ListCertificatesByCARequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ascendingOrder

java.lang.Boolean ascendingOrder

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

caCertificateId

java.lang.String caCertificateId

The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

marker

java.lang.String marker

The marker for the next set of results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

pageSize

java.lang.Integer pageSize

The result page size.

Constraints:
Range: 1 - 250

Class com.amazonaws.services.iot.model.ListCertificatesByCAResult extends java.lang.Object implements Serializable

Serialized Fields

certificates

java.util.List<Certificate> certificates

The device certificates signed by the specified CA certificate.

nextMarker

java.lang.String nextMarker

The marker for the next set of results, or null if there are no additional results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

Class com.amazonaws.services.iot.model.ListCertificatesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ascendingOrder

java.lang.Boolean ascendingOrder

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

marker

java.lang.String marker

The marker for the next set of results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

pageSize

java.lang.Integer pageSize

The result page size.

Constraints:
Range: 1 - 250

Class com.amazonaws.services.iot.model.ListCertificatesResult extends java.lang.Object implements Serializable

Serialized Fields

certificates

java.util.List<Certificate> certificates

The descriptions of the certificates.

nextMarker

java.lang.String nextMarker

The marker for the next set of results, or null if there are no additional results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

Class com.amazonaws.services.iot.model.ListCustomMetricsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time. The default is 25.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token for the next set of results.

Class com.amazonaws.services.iot.model.ListCustomMetricsResult extends java.lang.Object implements Serializable

Serialized Fields

metricNames

java.util.List<java.lang.String> metricNames

The name of the custom metric.

nextToken

java.lang.String nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

Class com.amazonaws.services.iot.model.ListDetectMitigationActionsExecutionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endTime

java.util.Date endTime

The end of the time period for which ML Detect mitigation actions executions are returned.

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time. The default is 25.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token for the next set of results.

startTime

java.util.Date startTime

A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.

taskId

java.lang.String taskId

The unique identifier of the task.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

thingName

java.lang.String thingName

The name of the thing whose mitigation actions are listed.

Constraints:
Length: 1 - 128

violationId

java.lang.String violationId

The unique identifier of the violation.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+

Class com.amazonaws.services.iot.model.ListDetectMitigationActionsExecutionsResult extends java.lang.Object implements Serializable

Serialized Fields

actionsExecutions

java.util.List<DetectMitigationActionExecution> actionsExecutions

List of actions executions.

nextToken

java.lang.String nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

Class com.amazonaws.services.iot.model.ListDetectMitigationActionsTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endTime

java.util.Date endTime

The end of the time period for which ML Detect mitigation actions tasks are returned.

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time. The default is 25.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token for the next set of results.

startTime

java.util.Date startTime

A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.

Class com.amazonaws.services.iot.model.ListDetectMitigationActionsTasksResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

tasks

java.util.List<DetectMitigationActionsTaskSummary> tasks

The collection of ML Detect mitigation tasks that matched the filter criteria.

Class com.amazonaws.services.iot.model.ListDimensionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to retrieve at one time.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token for the next set of results.

Class com.amazonaws.services.iot.model.ListDimensionsResult extends java.lang.Object implements Serializable

Serialized Fields

dimensionNames

java.util.List<java.lang.String> dimensionNames

A list of the names of the defined dimensions. Use DescribeDimension to get details for a dimension.

nextToken

java.lang.String nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

Class com.amazonaws.services.iot.model.ListDomainConfigurationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

marker

java.lang.String marker

The marker for the next set of results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

pageSize

java.lang.Integer pageSize

The result page size.

Constraints:
Range: 1 - 250

serviceType

java.lang.String serviceType

The type of service delivered by the endpoint.

Constraints:
Allowed Values: DATA, CREDENTIAL_PROVIDER, JOBS

Class com.amazonaws.services.iot.model.ListDomainConfigurationsResult extends java.lang.Object implements Serializable

Serialized Fields

domainConfigurations

java.util.List<DomainConfigurationSummary> domainConfigurations

A list of objects that contain summary information about the user's domain configurations.

nextMarker

java.lang.String nextMarker

The marker for the next set of results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

Class com.amazonaws.services.iot.model.ListFleetMetricsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return in this operation.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Class com.amazonaws.services.iot.model.ListFleetMetricsResult extends java.lang.Object implements Serializable

Serialized Fields

fleetMetrics

java.util.List<FleetMetricNameAndArn> fleetMetrics

The list of fleet metrics objects.

nextToken

java.lang.String nextToken

The token for the next set of results. Will not be returned if the operation has returned all results.

Class com.amazonaws.services.iot.model.ListIndicesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

The token used to get the next set of results, or null if there are no additional results.

Class com.amazonaws.services.iot.model.ListIndicesResult extends java.lang.Object implements Serializable

Serialized Fields

indexNames

java.util.List<java.lang.String> indexNames

The index names.

nextToken

java.lang.String nextToken

The token used to get the next set of results, or null if there are no additional results.

Class com.amazonaws.services.iot.model.ListJobExecutionsForJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The unique identifier you assigned to this job when it was created.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

maxResults

java.lang.Integer maxResults

The maximum number of results to be returned per request.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token to retrieve the next set of results.

status

java.lang.String status

The status of the job.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, TIMED_OUT, REJECTED, REMOVED, CANCELED

Class com.amazonaws.services.iot.model.ListJobExecutionsForJobResult extends java.lang.Object implements Serializable

Serialized Fields

executionSummaries

java.util.List<JobExecutionSummaryForJob> executionSummaries

A list of job execution summaries.

nextToken

java.lang.String nextToken

The token for the next set of results, or null if there are no additional results.

Class com.amazonaws.services.iot.model.ListJobExecutionsForThingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The unique identifier you assigned to this job when it was created.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

maxResults

java.lang.Integer maxResults

The maximum number of results to be returned per request.

Constraints:
Range: 1 - 250

namespaceId

java.lang.String namespaceId

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

nextToken

java.lang.String nextToken

The token to retrieve the next set of results.

status

java.lang.String status

An optional filter that lets you search for jobs that have the specified status.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, TIMED_OUT, REJECTED, REMOVED, CANCELED

thingName

java.lang.String thingName

The thing name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.ListJobExecutionsForThingResult extends java.lang.Object implements Serializable

Serialized Fields

executionSummaries

java.util.List<JobExecutionSummaryForThing> executionSummaries

A list of job execution summaries.

nextToken

java.lang.String nextToken

The token for the next set of results, or null if there are no additional results.

Class com.amazonaws.services.iot.model.ListJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return per request.

Constraints:
Range: 1 - 250

namespaceId

java.lang.String namespaceId

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

nextToken

java.lang.String nextToken

The token to retrieve the next set of results.

status

java.lang.String status

An optional filter that lets you search for jobs that have the specified status.

Constraints:
Allowed Values: IN_PROGRESS, CANCELED, COMPLETED, DELETION_IN_PROGRESS

targetSelection

java.lang.String targetSelection

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT

thingGroupId

java.lang.String thingGroupId

A filter that limits the returned jobs to those for the specified group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+

thingGroupName

java.lang.String thingGroupName

A filter that limits the returned jobs to those for the specified group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.ListJobsResult extends java.lang.Object implements Serializable

Serialized Fields

jobs

java.util.List<JobSummary> jobs

A list of jobs.

nextToken

java.lang.String nextToken

The token for the next set of results, or null if there are no additional results.

Class com.amazonaws.services.iot.model.ListJobTemplatesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return in the list.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token to use to return the next set of results in the list.

Class com.amazonaws.services.iot.model.ListJobTemplatesResult extends java.lang.Object implements Serializable

Serialized Fields

jobTemplates

java.util.List<JobTemplateSummary> jobTemplates

A list of objects that contain information about the job templates.

nextToken

java.lang.String nextToken

The token for the next set of results, or null if there are no additional results.

Class com.amazonaws.services.iot.model.ListManagedJobTemplatesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

Maximum number of entries that can be returned.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token to retrieve the next set of results.

templateName

java.lang.String templateName

An optional parameter for template name. If specified, only the versions of the managed job templates that have the specified template name will be returned.

Constraints:
Length: 1 - 64

Class com.amazonaws.services.iot.model.ListManagedJobTemplatesResult extends java.lang.Object implements Serializable

Serialized Fields

managedJobTemplates

java.util.List<ManagedJobTemplateSummary> managedJobTemplates

A list of managed job templates that are returned.

nextToken

java.lang.String nextToken

The token to retrieve the next set of results.

Class com.amazonaws.services.iot.model.ListMetricValuesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dimensionName

java.lang.String dimensionName

The dimension name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

dimensionValueOperator

java.lang.String dimensionValueOperator

The dimension value operator.

Constraints:
Allowed Values: IN, NOT_IN

endTime

java.util.Date endTime

The end of the time period for which metric values are returned.

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

metricName

java.lang.String metricName

The name of the security profile metric for which values are returned.

nextToken

java.lang.String nextToken

The token for the next set of results.

startTime

java.util.Date startTime

The start of the time period for which metric values are returned.

thingName

java.lang.String thingName

The name of the thing for which security profile metric values are returned.

Constraints:
Length: 1 - 128

Class com.amazonaws.services.iot.model.ListMetricValuesResult extends java.lang.Object implements Serializable

Serialized Fields

metricDatumList

java.util.List<MetricDatum> metricDatumList

The data the thing reports for the metric during the specified time period.

nextToken

java.lang.String nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

Class com.amazonaws.services.iot.model.ListMitigationActionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

actionType

java.lang.String actionType

Specify a value to limit the result to mitigation actions with a specific action type.

Constraints:
Allowed Values: UPDATE_DEVICE_CERTIFICATE, UPDATE_CA_CERTIFICATE, ADD_THINGS_TO_THING_GROUP, REPLACE_DEFAULT_POLICY_VERSION, ENABLE_IOT_LOGGING, PUBLISH_FINDING_TO_SNS

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time. The default is 25.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token for the next set of results.

Class com.amazonaws.services.iot.model.ListMitigationActionsResult extends java.lang.Object implements Serializable

Serialized Fields

actionIdentifiers

java.util.List<MitigationActionIdentifier> actionIdentifiers

A set of actions that matched the specified filter criteria.

nextToken

java.lang.String nextToken

The token for the next set of results.

Class com.amazonaws.services.iot.model.ListOTAUpdatesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

A token used to retrieve the next set of results.

otaUpdateStatus

java.lang.String otaUpdateStatus

The OTA update job status.

Constraints:
Allowed Values: CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_COMPLETE, CREATE_FAILED

Class com.amazonaws.services.iot.model.ListOTAUpdatesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A token to use to get the next set of results.

otaUpdates

java.util.List<OTAUpdateSummary> otaUpdates

A list of OTA update jobs.

Class com.amazonaws.services.iot.model.ListOutgoingCertificatesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ascendingOrder

java.lang.Boolean ascendingOrder

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

marker

java.lang.String marker

The marker for the next set of results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

pageSize

java.lang.Integer pageSize

The result page size.

Constraints:
Range: 1 - 250

Class com.amazonaws.services.iot.model.ListOutgoingCertificatesResult extends java.lang.Object implements Serializable

Serialized Fields

nextMarker

java.lang.String nextMarker

The marker for the next set of results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

outgoingCertificates

java.util.List<OutgoingCertificate> outgoingCertificates

The certificates that are being transferred but not yet accepted.

Class com.amazonaws.services.iot.model.ListPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ascendingOrder

java.lang.Boolean ascendingOrder

Specifies the order for results. If true, the results are returned in ascending creation order.

marker

java.lang.String marker

The marker for the next set of results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

pageSize

java.lang.Integer pageSize

The result page size.

Constraints:
Range: 1 - 250

Class com.amazonaws.services.iot.model.ListPoliciesResult extends java.lang.Object implements Serializable

Serialized Fields

nextMarker

java.lang.String nextMarker

The marker for the next set of results, or null if there are no additional results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

policies

java.util.List<Policy> policies

The descriptions of the policies.

Class com.amazonaws.services.iot.model.ListPolicyPrincipalsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ascendingOrder

java.lang.Boolean ascendingOrder

Specifies the order for results. If true, the results are returned in ascending creation order.

marker

java.lang.String marker

The marker for the next set of results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

pageSize

java.lang.Integer pageSize

The result page size.

Constraints:
Range: 1 - 250

policyName

java.lang.String policyName

The policy name.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Class com.amazonaws.services.iot.model.ListPolicyPrincipalsResult extends java.lang.Object implements Serializable

Serialized Fields

nextMarker

java.lang.String nextMarker

The marker for the next set of results, or null if there are no additional results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

principals

java.util.List<java.lang.String> principals

The descriptions of the principals.

Class com.amazonaws.services.iot.model.ListPolicyVersionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

java.lang.String policyName

The policy name.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Class com.amazonaws.services.iot.model.ListPolicyVersionsResult extends java.lang.Object implements Serializable

Serialized Fields

policyVersions

java.util.List<PolicyVersion> policyVersions

The policy versions.

Class com.amazonaws.services.iot.model.ListPrincipalPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ascendingOrder

java.lang.Boolean ascendingOrder

Specifies the order for results. If true, results are returned in ascending creation order.

marker

java.lang.String marker

The marker for the next set of results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

pageSize

java.lang.Integer pageSize

The result page size.

Constraints:
Range: 1 - 250

principal

java.lang.String principal

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

Class com.amazonaws.services.iot.model.ListPrincipalPoliciesResult extends java.lang.Object implements Serializable

Serialized Fields

nextMarker

java.lang.String nextMarker

The marker for the next set of results, or null if there are no additional results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

policies

java.util.List<Policy> policies

The policies.

Class com.amazonaws.services.iot.model.ListPrincipalThingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return in this operation.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

principal

java.lang.String principal

The principal.

Class com.amazonaws.services.iot.model.ListPrincipalThingsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to get the next set of results, or null if there are no additional results.

things

java.util.List<java.lang.String> things

The things.

Class com.amazonaws.services.iot.model.ListProvisioningTemplatesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

A token to retrieve the next set of results.

Class com.amazonaws.services.iot.model.ListProvisioningTemplatesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A token to retrieve the next set of results.

templates

java.util.List<ProvisioningTemplateSummary> templates

A list of provisioning templates

Class com.amazonaws.services.iot.model.ListProvisioningTemplateVersionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

A token to retrieve the next set of results.

templateName

java.lang.String templateName

The name of the provisioning template.

Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$

Class com.amazonaws.services.iot.model.ListProvisioningTemplateVersionsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A token to retrieve the next set of results.

versions

java.util.List<ProvisioningTemplateVersionSummary> versions

The list of provisioning template versions.

Class com.amazonaws.services.iot.model.ListRoleAliasesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ascendingOrder

java.lang.Boolean ascendingOrder

Return the list of role aliases in ascending alphabetical order.

marker

java.lang.String marker

A marker used to get the next set of results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

pageSize

java.lang.Integer pageSize

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

Class com.amazonaws.services.iot.model.ListRoleAliasesResult extends java.lang.Object implements Serializable

Serialized Fields

nextMarker

java.lang.String nextMarker

A marker used to get the next set of results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

roleAliases

java.util.List<java.lang.String> roleAliases

The role aliases.

Class com.amazonaws.services.iot.model.ListScheduledAuditsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time. The default is 25.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token for the next set of results.

Class com.amazonaws.services.iot.model.ListScheduledAuditsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

scheduledAudits

java.util.List<ScheduledAuditMetadata> scheduledAudits

The list of scheduled audits.

Class com.amazonaws.services.iot.model.ListSecurityProfilesForTargetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token for the next set of results.

recursive

java.lang.Boolean recursive

If true, return child groups too.

securityProfileTargetArn

java.lang.String securityProfileTargetArn

The ARN of the target (thing group) whose attached security profiles you want to get.

Class com.amazonaws.services.iot.model.ListSecurityProfilesForTargetResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

securityProfileTargetMappings

java.util.List<SecurityProfileTargetMapping> securityProfileTargetMappings

A list of security profiles and their associated targets.

Class com.amazonaws.services.iot.model.ListSecurityProfilesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dimensionName

java.lang.String dimensionName

A filter to limit results to the security profiles that use the defined dimension. Cannot be used with metricName

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

metricName

java.lang.String metricName

The name of the custom metric. Cannot be used with dimensionName.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

nextToken

java.lang.String nextToken

The token for the next set of results.

Class com.amazonaws.services.iot.model.ListSecurityProfilesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

securityProfileIdentifiers

java.util.List<SecurityProfileIdentifier> securityProfileIdentifiers

A list of security profile identifiers (names and ARNs).

Class com.amazonaws.services.iot.model.ListStreamsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ascendingOrder

java.lang.Boolean ascendingOrder

Set to true to return the list of streams in ascending order.

maxResults

java.lang.Integer maxResults

The maximum number of results to return at a time.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

A token used to get the next set of results.

Class com.amazonaws.services.iot.model.ListStreamsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A token used to get the next set of results.

streams

java.util.List<StreamSummary> streams

A list of streams.

Class com.amazonaws.services.iot.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

resourceArn

java.lang.String resourceArn

The ARN of the resource.

Class com.amazonaws.services.iot.model.ListTagsForResourceResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to get the next set of results, or null if there are no additional results.

tags

java.util.List<Tag> tags

The list of tags assigned to the resource.

Class com.amazonaws.services.iot.model.ListTargetsForPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

marker

java.lang.String marker

A marker used to get the next set of results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

pageSize

java.lang.Integer pageSize

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

policyName

java.lang.String policyName

The policy name.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Class com.amazonaws.services.iot.model.ListTargetsForPolicyResult extends java.lang.Object implements Serializable

Serialized Fields

nextMarker

java.lang.String nextMarker

A marker used to get the next set of results.

Constraints:
Length: - 1024
Pattern: [A-Za-z0-9+/]+={0,2}

targets

java.util.List<java.lang.String> targets

The policy targets.

Class com.amazonaws.services.iot.model.ListTargetsForSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token for the next set of results.

securityProfileName

java.lang.String securityProfileName

The security profile.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.ListTargetsForSecurityProfileResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

securityProfileTargets

java.util.List<SecurityProfileTarget> securityProfileTargets

The thing groups to which the security profile is attached.

Class com.amazonaws.services.iot.model.ListThingGroupsForThingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

thingName

java.lang.String thingName

The thing name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.ListThingGroupsForThingResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to get the next set of results, or null if there are no additional results.

thingGroups

java.util.List<GroupNameAndArn> thingGroups

The thing groups.

Class com.amazonaws.services.iot.model.ListThingGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

namePrefixFilter

java.lang.String namePrefixFilter

A filter that limits the results to those with the specified name prefix.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

nextToken

java.lang.String nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

parentGroup

java.lang.String parentGroup

A filter that limits the results to those with the specified parent group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

recursive

java.lang.Boolean recursive

If true, return child groups as well.

Class com.amazonaws.services.iot.model.ListThingGroupsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to get the next set of results. Will not be returned if operation has returned all results.

thingGroups

java.util.List<GroupNameAndArn> thingGroups

The thing groups.

Class com.amazonaws.services.iot.model.ListThingPrincipalsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return in this operation.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

thingName

java.lang.String thingName

The name of the thing.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.ListThingPrincipalsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to get the next set of results, or null if there are no additional results.

principals

java.util.List<java.lang.String> principals

The principals associated with the thing.

Class com.amazonaws.services.iot.model.ListThingRegistrationTaskReportsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return per request.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

reportType

java.lang.String reportType

The type of task report.

Constraints:
Allowed Values: ERRORS, RESULTS

taskId

java.lang.String taskId

The id of the task.

Constraints:
Length: - 40

Class com.amazonaws.services.iot.model.ListThingRegistrationTaskReportsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to get the next set of results, or null if there are no additional results.

reportType

java.lang.String reportType

The type of task report.

Constraints:
Allowed Values: ERRORS, RESULTS

resourceLinks

java.util.List<java.lang.String> resourceLinks

Links to the task resources.

Class com.amazonaws.services.iot.model.ListThingRegistrationTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

status

java.lang.String status

The status of the bulk thing provisioning task.

Constraints:
Allowed Values: InProgress, Completed, Failed, Cancelled, Cancelling

Class com.amazonaws.services.iot.model.ListThingRegistrationTasksResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to get the next set of results, or null if there are no additional results.

taskIds

java.util.List<java.lang.String> taskIds

A list of bulk thing provisioning task IDs.

Class com.amazonaws.services.iot.model.ListThingsInBillingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

billingGroupName

java.lang.String billingGroupName

The name of the billing group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

maxResults

java.lang.Integer maxResults

The maximum number of results to return per request.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Class com.amazonaws.services.iot.model.ListThingsInBillingGroupResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to get the next set of results. Will not be returned if operation has returned all results.

things

java.util.List<java.lang.String> things

A list of things in the billing group.

Class com.amazonaws.services.iot.model.ListThingsInThingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

recursive

java.lang.Boolean recursive

When true, list things in this thing group and in all child groups as well.

thingGroupName

java.lang.String thingGroupName

The thing group name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.ListThingsInThingGroupResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to get the next set of results, or null if there are no additional results.

things

java.util.List<java.lang.String> things

The things in the specified thing group.

Class com.amazonaws.services.iot.model.ListThingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeName

java.lang.String attributeName

The attribute name used to search for things.

Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_.,@/:#-]+

attributeValue

java.lang.String attributeValue

The attribute value used to search for things.

Constraints:
Length: - 800
Pattern: [a-zA-Z0-9_.,@/:#-]*

maxResults

java.lang.Integer maxResults

The maximum number of results to return in this operation.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

thingTypeName

java.lang.String thingTypeName

The name of the thing type used to search for things.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

usePrefixAttributeValue

java.lang.Boolean usePrefixAttributeValue

When true, the action returns the thing resources with attribute values that start with the attributeValue provided.

When false, or not present, the action returns only the thing resources with attribute values that match the entire attributeValue provided.

Class com.amazonaws.services.iot.model.ListThingsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to get the next set of results. Will not be returned if operation has returned all results.

things

java.util.List<ThingAttribute> things

The things.

Class com.amazonaws.services.iot.model.ListThingTypesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return in this operation.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

thingTypeName

java.lang.String thingTypeName

The name of the thing type.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.ListThingTypesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token for the next set of results. Will not be returned if operation has returned all results.

thingTypes

java.util.List<ThingTypeDefinition> thingTypes

The thing types.

Class com.amazonaws.services.iot.model.ListTopicRuleDestinationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 1000

nextToken

java.lang.String nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Class com.amazonaws.services.iot.model.ListTopicRuleDestinationsResult extends java.lang.Object implements Serializable

Serialized Fields

destinationSummaries

java.util.List<TopicRuleDestinationSummary> destinationSummaries

Information about a topic rule destination.

nextToken

java.lang.String nextToken

The token to use to get the next set of results, or null if there are no additional results.

Class com.amazonaws.services.iot.model.ListTopicRulesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return.

Constraints:
Range: 1 - 10000

nextToken

java.lang.String nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

ruleDisabled

java.lang.Boolean ruleDisabled

Specifies whether the rule is disabled.

topic

java.lang.String topic

The topic.

Class com.amazonaws.services.iot.model.ListTopicRulesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to get the next set of results, or null if there are no additional results.

rules

java.util.List<TopicRuleListItem> rules

The rules.

Class com.amazonaws.services.iot.model.ListV2LoggingLevelsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

targetType

java.lang.String targetType

The type of resource for which you are configuring logging. Must be THING_Group.

Constraints:
Allowed Values: DEFAULT, THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID

Class com.amazonaws.services.iot.model.ListV2LoggingLevelsResult extends java.lang.Object implements Serializable

Serialized Fields

logTargetConfigurations

java.util.List<LogTargetConfiguration> logTargetConfigurations

The logging configuration for a target.

nextToken

java.lang.String nextToken

The token to use to get the next set of results, or null if there are no additional results.

Class com.amazonaws.services.iot.model.ListViolationEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

behaviorCriteriaType

java.lang.String behaviorCriteriaType

The criteria for a behavior.

Constraints:
Allowed Values: STATIC, STATISTICAL, MACHINE_LEARNING

endTime

java.util.Date endTime

The end time for the alerts to be listed.

listSuppressedAlerts

java.lang.Boolean listSuppressedAlerts

A list of all suppressed alerts.

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 250

nextToken

java.lang.String nextToken

The token for the next set of results.

securityProfileName

java.lang.String securityProfileName

A filter to limit results to those alerts generated by the specified security profile.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

startTime

java.util.Date startTime

The start time for the alerts to be listed.

thingName

java.lang.String thingName

A filter to limit results to those alerts caused by the specified thing.

Constraints:
Length: 1 - 128

verificationState

java.lang.String verificationState

The verification state of the violation (detect alarm).

Constraints:
Allowed Values: FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN

Class com.amazonaws.services.iot.model.ListViolationEventsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

violationEvents

java.util.List<ViolationEvent> violationEvents

The security profile violation alerts issued for this account during the given time period, potentially filtered by security profile, behavior violated, or thing (device) violating.

Class com.amazonaws.services.iot.model.LoggingOptionsPayload extends java.lang.Object implements Serializable

Serialized Fields

logLevel

java.lang.String logLevel

The log level.

Constraints:
Allowed Values: DEBUG, INFO, ERROR, WARN, DISABLED

roleArn

java.lang.String roleArn

The ARN of the IAM role that grants access.

Class com.amazonaws.services.iot.model.LogTarget extends java.lang.Object implements Serializable

Serialized Fields

targetName

java.lang.String targetName

The target name.

targetType

java.lang.String targetType

The target type.

Constraints:
Allowed Values: DEFAULT, THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID

Class com.amazonaws.services.iot.model.LogTargetConfiguration extends java.lang.Object implements Serializable

Serialized Fields

logLevel

java.lang.String logLevel

The logging level.

Constraints:
Allowed Values: DEBUG, INFO, ERROR, WARN, DISABLED

logTarget

LogTarget logTarget

A log target

Class com.amazonaws.services.iot.model.MachineLearningDetectionConfig extends java.lang.Object implements Serializable

Serialized Fields

confidenceLevel

java.lang.String confidenceLevel

The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.

Constraints:
Allowed Values: LOW, MEDIUM, HIGH

Class com.amazonaws.services.iot.model.MalformedPolicyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.ManagedJobTemplateSummary extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

The description for a managed template.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

environments

java.util.List<java.lang.String> environments

A list of environments that are supported with the managed job template.

templateArn

java.lang.String templateArn

The Amazon Resource Name (ARN) for a managed template.

Constraints:
Length: 1 - 1600
Pattern: ^arn:[!-~]+$

templateName

java.lang.String templateName

The unique Name for a managed template.

Constraints:
Length: 1 - 64

templateVersion

java.lang.String templateVersion

The version for a managed template.

Constraints:
Pattern: ^[1-9]+.[0-9]+

Class com.amazonaws.services.iot.model.MetricDatum extends java.lang.Object implements Serializable

Serialized Fields

timestamp

java.util.Date timestamp

The time the metric value was reported.

value

MetricValue value

The value reported for the metric.

Class com.amazonaws.services.iot.model.MetricDimension extends java.lang.Object implements Serializable

Serialized Fields

dimensionName

java.lang.String dimensionName

A unique identifier for the dimension.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

operator

java.lang.String operator

Defines how the dimensionValues of a dimension are interpreted. For example, for dimension type TOPIC_FILTER, the IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.

Constraints:
Allowed Values: IN, NOT_IN

Class com.amazonaws.services.iot.model.MetricToRetain extends java.lang.Object implements Serializable

Serialized Fields

metric

java.lang.String metric

What is measured by the behavior.

metricDimension

MetricDimension metricDimension

The dimension of a metric. This can't be used with custom metrics.

Class com.amazonaws.services.iot.model.MetricValue extends java.lang.Object implements Serializable

Serialized Fields

cidrs

java.util.List<java.lang.String> cidrs

If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.

count

java.lang.Long count

If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric.

Constraints:
Range: 0 -

number

java.lang.Double number

The numeral value of a metric.

numbers

java.util.List<java.lang.Double> numbers

The numeral values of a metric.

ports

java.util.List<java.lang.Integer> ports

If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.

strings

java.util.List<java.lang.String> strings

The string values of a metric.

Class com.amazonaws.services.iot.model.MitigationAction extends java.lang.Object implements Serializable

Serialized Fields

actionParams

MitigationActionParams actionParams

The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.

id

java.lang.String id

A unique identifier for the mitigation action.

name

java.lang.String name

A user-friendly name for the mitigation action.

Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_-]+

roleArn

java.lang.String roleArn

The IAM role ARN used to apply this mitigation action.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.iot.model.MitigationActionIdentifier extends java.lang.Object implements Serializable

Serialized Fields

actionArn

java.lang.String actionArn

The IAM role ARN used to apply this mitigation action.

actionName

java.lang.String actionName

The friendly name of the mitigation action.

Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_-]+

creationDate

java.util.Date creationDate

The date when this mitigation action was created.

Class com.amazonaws.services.iot.model.MitigationActionParams extends java.lang.Object implements Serializable

Serialized Fields

addThingsToThingGroupParams

AddThingsToThingGroupParams addThingsToThingGroupParams

Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

enableIoTLoggingParams

EnableIoTLoggingParams enableIoTLoggingParams

Parameters to define a mitigation action that enables Amazon Web Services IoT Core logging at a specified level of detail.

publishFindingToSnsParams

PublishFindingToSnsParams publishFindingToSnsParams

Parameters to define a mitigation action that publishes findings to Amazon Simple Notification Service (Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.

replaceDefaultPolicyVersionParams

ReplaceDefaultPolicyVersionParams replaceDefaultPolicyVersionParams

Parameters to define a mitigation action that adds a blank policy to restrict permissions.

updateCACertificateParams

UpdateCACertificateParams updateCACertificateParams

Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

updateDeviceCertificateParams

UpdateDeviceCertificateParams updateDeviceCertificateParams

Parameters to define a mitigation action that changes the state of the device certificate to inactive.

Class com.amazonaws.services.iot.model.MqttContext extends java.lang.Object implements Serializable

Serialized Fields

clientId

java.lang.String clientId

The value of the clientId key in an MQTT authorization request.

Constraints:
Length: 1 - 65535
Pattern: [\s\S]*

password

java.nio.ByteBuffer password

The value of the password key in an MQTT authorization request.

Constraints:
Length: 1 - 65535

username

java.lang.String username

The value of the username key in an MQTT authorization request.

Constraints:
Length: 1 - 65535
Pattern: [\s\S]*

Class com.amazonaws.services.iot.model.NonCompliantResource extends java.lang.Object implements Serializable

Serialized Fields

additionalInfo

java.util.Map<java.lang.String,java.lang.String> additionalInfo

Other information about the noncompliant resource.

resourceIdentifier

ResourceIdentifier resourceIdentifier

Information that identifies the noncompliant resource.

resourceType

java.lang.String resourceType

The type of the noncompliant resource.

Constraints:
Allowed Values: DEVICE_CERTIFICATE, CA_CERTIFICATE, IOT_POLICY, COGNITO_IDENTITY_POOL, CLIENT_ID, ACCOUNT_SETTINGS, ROLE_ALIAS, IAM_ROLE

Class com.amazonaws.services.iot.model.NotConfiguredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.OpenSearchAction extends java.lang.Object implements Serializable

Serialized Fields

endpoint

java.lang.String endpoint

The endpoint of your OpenSearch domain.

Constraints:
Pattern: https?://.*

id

java.lang.String id

The unique identifier for the document you are storing.

index

java.lang.String index

The OpenSearch index where you want to store your data.

roleArn

java.lang.String roleArn

The IAM role ARN that has access to OpenSearch.

type

java.lang.String type

The type of document you are storing.

Class com.amazonaws.services.iot.model.OTAUpdateFile extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

A list of name/attribute pairs.

codeSigning

CodeSigning codeSigning

The code signing method of the file.

fileLocation

FileLocation fileLocation

The location of the updated firmware.

fileName

java.lang.String fileName

The name of the file.

fileType

java.lang.Integer fileType

An integer value you can include in the job document to allow your devices to identify the type of file received from the cloud.

Constraints:
Range: 0 - 255

fileVersion

java.lang.String fileVersion

The file version.

Class com.amazonaws.services.iot.model.OTAUpdateInfo extends java.lang.Object implements Serializable

Serialized Fields

additionalParameters

java.util.Map<java.lang.String,java.lang.String> additionalParameters

A collection of name/value pairs

awsIotJobArn

java.lang.String awsIotJobArn

The IoT job ARN associated with the OTA update.

awsIotJobId

java.lang.String awsIotJobId

The IoT job ID associated with the OTA update.

awsJobExecutionsRolloutConfig

AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig

Configuration for the rollout of OTA updates.

awsJobPresignedUrlConfig

AwsJobPresignedUrlConfig awsJobPresignedUrlConfig

Configuration information for pre-signed URLs. Valid when protocols contains HTTP.

creationDate

java.util.Date creationDate

The date when the OTA update was created.

description

java.lang.String description

A description of the OTA update.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

errorInfo

ErrorInfo errorInfo

Error information associated with the OTA update.

lastModifiedDate

java.util.Date lastModifiedDate

The date when the OTA update was last updated.

otaUpdateArn

java.lang.String otaUpdateArn

The OTA update ARN.

otaUpdateFiles

java.util.List<OTAUpdateFile> otaUpdateFiles

A list of files associated with the OTA update.

otaUpdateId

java.lang.String otaUpdateId

The OTA update ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

otaUpdateStatus

java.lang.String otaUpdateStatus

The status of the OTA update.

Constraints:
Allowed Values: CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_COMPLETE, CREATE_FAILED

protocols

java.util.List<java.lang.String> protocols

The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.

targets

java.util.List<java.lang.String> targets

The targets of the OTA update.

targetSelection

java.lang.String targetSelection

Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.

Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT

Class com.amazonaws.services.iot.model.OTAUpdateSummary extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The date when the OTA update was created.

otaUpdateArn

java.lang.String otaUpdateArn

The OTA update ARN.

otaUpdateId

java.lang.String otaUpdateId

The OTA update ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.OutgoingCertificate extends java.lang.Object implements Serializable

Serialized Fields

certificateArn

java.lang.String certificateArn

The certificate ARN.

certificateId

java.lang.String certificateId

The certificate ID.

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

creationDate

java.util.Date creationDate

The certificate creation date.

transferDate

java.util.Date transferDate

The date the transfer was initiated.

transferMessage

java.lang.String transferMessage

The transfer message.

Constraints:
Length: - 128
Pattern: [\s\S]*

transferredTo

java.lang.String transferredTo

The Amazon Web Services account to which the transfer was made.

Constraints:
Length: 12 - 12
Pattern: [0-9]+

Class com.amazonaws.services.iot.model.PercentPair extends java.lang.Object implements Serializable

Serialized Fields

percent

java.lang.Double percent

The percentile.

Constraints:
Range: 0.0 - 100.0

value

java.lang.Double value

The value of the percentile.

Class com.amazonaws.services.iot.model.Policy extends java.lang.Object implements Serializable

Serialized Fields

policyArn

java.lang.String policyArn

The policy ARN.

policyName

java.lang.String policyName

The policy name.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Class com.amazonaws.services.iot.model.PolicyVersion extends java.lang.Object implements Serializable

Serialized Fields

createDate

java.util.Date createDate

The date and time the policy was created.

isDefaultVersion

java.lang.Boolean isDefaultVersion

Specifies whether the policy version is the default.

versionId

java.lang.String versionId

The policy version ID.

Constraints:
Pattern: [0-9]+

Class com.amazonaws.services.iot.model.PolicyVersionIdentifier extends java.lang.Object implements Serializable

Serialized Fields

policyName

java.lang.String policyName

The name of the policy.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

policyVersionId

java.lang.String policyVersionId

The ID of the version of the policy associated with the resource.

Constraints:
Pattern: [0-9]+

Class com.amazonaws.services.iot.model.PresignedUrlConfig extends java.lang.Object implements Serializable

Serialized Fields

expiresInSec

java.lang.Long expiresInSec

How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.

Constraints:
Range: 60 - 3600

roleArn

java.lang.String roleArn

The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.

For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the Amazon Web Services IoT Core developer guide.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.iot.model.ProvisioningHook extends java.lang.Object implements Serializable

Serialized Fields

payloadVersion

java.lang.String payloadVersion

The payload that was sent to the target function.

Note: Only Lambda functions are currently supported.

Constraints:
Length: 10 - 32
Pattern: ^[0-9-]+$

targetArn

java.lang.String targetArn

The ARN of the target function.

Note: Only Lambda functions are currently supported.

Constraints:
Length: - 2048

Class com.amazonaws.services.iot.model.ProvisioningTemplateSummary extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The date when the provisioning template summary was created.

description

java.lang.String description

The description of the provisioning template.

Constraints:
Length: 0 - 500
Pattern: [^\p{C}]*

enabled

java.lang.Boolean enabled

True if the fleet provision template is enabled, otherwise false.

lastModifiedDate

java.util.Date lastModifiedDate

The date when the provisioning template summary was last modified.

templateArn

java.lang.String templateArn

The ARN of the provisioning template.

templateName

java.lang.String templateName

The name of the provisioning template.

Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$

type

java.lang.String type

The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template.

Constraints:
Allowed Values: FLEET_PROVISIONING, JITP

Class com.amazonaws.services.iot.model.ProvisioningTemplateVersionSummary extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The date when the provisioning template version was created

isDefaultVersion

java.lang.Boolean isDefaultVersion

True if the provisioning template version is the default version, otherwise false.

versionId

java.lang.Integer versionId

The ID of the fleet privisioning template version.

Class com.amazonaws.services.iot.model.PublishFindingToSnsParams extends java.lang.Object implements Serializable

Serialized Fields

topicArn

java.lang.String topicArn

The ARN of the topic to which you want to publish the findings.

Constraints:
Length: - 350

Class com.amazonaws.services.iot.model.PutAssetPropertyValueEntry extends java.lang.Object implements Serializable

Serialized Fields

assetId

java.lang.String assetId

The ID of the IoT SiteWise asset. You must specify either a propertyAlias or both an aliasId and a propertyId. Accepts substitution templates.

entryId

java.lang.String entryId

Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.

propertyAlias

java.lang.String propertyAlias

The name of the property alias associated with your asset property. You must specify either a propertyAlias or both an aliasId and a propertyId. Accepts substitution templates.

Constraints:
Length: 1 -

propertyId

java.lang.String propertyId

The ID of the asset's property. You must specify either a propertyAlias or both an aliasId and a propertyId. Accepts substitution templates.

propertyValues

java.util.List<AssetPropertyValue> propertyValues

A list of property values to insert that each contain timestamp, quality, and value (TQV) information.

Class com.amazonaws.services.iot.model.PutItemInput extends java.lang.Object implements Serializable

Serialized Fields

tableName

java.lang.String tableName

The table where the message data will be written.

Class com.amazonaws.services.iot.model.PutVerificationStateOnViolationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

verificationState

java.lang.String verificationState

The verification state of the violation.

Constraints:
Allowed Values: FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN

verificationStateDescription

java.lang.String verificationStateDescription

The description of the verification state of the violation (detect alarm).

Constraints:
Length: - 1000
Pattern: [^\p{Cntrl}]*

violationId

java.lang.String violationId

The violation ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+

Class com.amazonaws.services.iot.model.PutVerificationStateOnViolationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.RateIncreaseCriteria extends java.lang.Object implements Serializable

Serialized Fields

numberOfNotifiedThings

java.lang.Integer numberOfNotifiedThings

The threshold for number of notified things that will initiate the increase in rate of rollout.

Constraints:
Range: 1 -

numberOfSucceededThings

java.lang.Integer numberOfSucceededThings

The threshold for number of succeeded things that will initiate the increase in rate of rollout.

Constraints:
Range: 1 -

Class com.amazonaws.services.iot.model.RegisterCACertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

allowAutoRegistration

java.lang.Boolean allowAutoRegistration

Allows this CA certificate to be used for auto registration of device certificates.

caCertificate

java.lang.String caCertificate

The CA certificate.

Constraints:
Length: 1 - 65536
Pattern: [\s\S]*

certificateMode

java.lang.String certificateMode

Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

Constraints:
Allowed Values: DEFAULT, SNI_ONLY

registrationConfig

RegistrationConfig registrationConfig

Information about the registration configuration.

setAsActive

java.lang.Boolean setAsActive

A boolean value that specifies if the CA certificate is set to active.

Valid values: ACTIVE | INACTIVE

tags

java.util.List<Tag> tags

Metadata which can be used to manage the CA certificate.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

verificationCertificate

java.lang.String verificationCertificate

The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT or not provided, the verificationCertificate field must not be empty.

Constraints:
Length: 1 - 65536
Pattern: [\s\S]*

Class com.amazonaws.services.iot.model.RegisterCACertificateResult extends java.lang.Object implements Serializable

Serialized Fields

certificateArn

java.lang.String certificateArn

The CA certificate ARN.

certificateId

java.lang.String certificateId

The CA certificate identifier.

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

Class com.amazonaws.services.iot.model.RegisterCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

caCertificatePem

java.lang.String caCertificatePem

The CA certificate used to sign the device certificate being registered.

Constraints:
Length: 1 - 65536
Pattern: [\s\S]*

certificatePem

java.lang.String certificatePem

The certificate data, in PEM format.

Constraints:
Length: 1 - 65536
Pattern: [\s\S]*

setAsActive

java.lang.Boolean setAsActive

A boolean value that specifies if the certificate is set to active.

Valid values: ACTIVE | INACTIVE

status

java.lang.String status

The status of the register certificate request. Valid values that you can use include ACTIVE, INACTIVE, and REVOKED.

Constraints:
Allowed Values: ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, REGISTER_INACTIVE, PENDING_ACTIVATION

Class com.amazonaws.services.iot.model.RegisterCertificateResult extends java.lang.Object implements Serializable

Serialized Fields

certificateArn

java.lang.String certificateArn

The certificate ARN.

certificateId

java.lang.String certificateId

The certificate identifier.

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

Class com.amazonaws.services.iot.model.RegisterCertificateWithoutCARequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificatePem

java.lang.String certificatePem

The certificate data, in PEM format.

Constraints:
Length: 1 - 65536
Pattern: [\s\S]*

status

java.lang.String status

The status of the register certificate request.

Constraints:
Allowed Values: ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, REGISTER_INACTIVE, PENDING_ACTIVATION

Class com.amazonaws.services.iot.model.RegisterCertificateWithoutCAResult extends java.lang.Object implements Serializable

Serialized Fields

certificateArn

java.lang.String certificateArn

The Amazon Resource Name (ARN) of the registered certificate.

certificateId

java.lang.String certificateId

The ID of the registered certificate. (The last part of the certificate ARN contains the certificate ID.

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

Class com.amazonaws.services.iot.model.RegisterThingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

parameters

java.util.Map<java.lang.String,java.lang.String> parameters

The parameters for provisioning a thing. See Provisioning Templates for more information.

templateBody

java.lang.String templateBody

The provisioning template. See Provisioning Devices That Have Device Certificates for more information.

Constraints:
Length: 0 - 10240
Pattern: [\s\S]*

Class com.amazonaws.services.iot.model.RegisterThingResult extends java.lang.Object implements Serializable

Serialized Fields

certificatePem

java.lang.String certificatePem

The certificate data, in PEM format.

Constraints:
Length: 1 - 65536
Pattern: [\s\S]*

resourceArns

java.util.Map<java.lang.String,java.lang.String> resourceArns

ARNs for the generated resources.

Class com.amazonaws.services.iot.model.RegistrationCodeValidationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.RegistrationConfig extends java.lang.Object implements Serializable

Serialized Fields

roleArn

java.lang.String roleArn

The ARN of the role.

Constraints:
Length: 20 - 2048

templateBody

java.lang.String templateBody

The template body.

Constraints:
Length: 0 - 10240
Pattern: [\s\S]*

templateName

java.lang.String templateName

The name of the provisioning template.

Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$

Class com.amazonaws.services.iot.model.RejectCertificateTransferRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

java.lang.String certificateId

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

rejectReason

java.lang.String rejectReason

The reason the certificate transfer was rejected.

Constraints:
Length: - 128
Pattern: [\s\S]*

Class com.amazonaws.services.iot.model.RelatedResource extends java.lang.Object implements Serializable

Serialized Fields

additionalInfo

java.util.Map<java.lang.String,java.lang.String> additionalInfo

Other information about the resource.

resourceIdentifier

ResourceIdentifier resourceIdentifier

Information that identifies the resource.

resourceType

java.lang.String resourceType

The type of resource.

Constraints:
Allowed Values: DEVICE_CERTIFICATE, CA_CERTIFICATE, IOT_POLICY, COGNITO_IDENTITY_POOL, CLIENT_ID, ACCOUNT_SETTINGS, ROLE_ALIAS, IAM_ROLE

Class com.amazonaws.services.iot.model.RemoveThingFromBillingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

billingGroupArn

java.lang.String billingGroupArn

The ARN of the billing group.

billingGroupName

java.lang.String billingGroupName

The name of the billing group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingArn

java.lang.String thingArn

The ARN of the thing to be removed from the billing group.

thingName

java.lang.String thingName

The name of the thing to be removed from the billing group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.RemoveThingFromBillingGroupResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.RemoveThingFromThingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

thingArn

java.lang.String thingArn

The ARN of the thing to remove from the group.

thingGroupArn

java.lang.String thingGroupArn

The group ARN.

thingGroupName

java.lang.String thingGroupName

The group name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingName

java.lang.String thingName

The name of the thing to remove from the group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.RemoveThingFromThingGroupResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.ReplaceDefaultPolicyVersionParams extends java.lang.Object implements Serializable

Serialized Fields

templateName

java.lang.String templateName

The name of the template to be applied. The only supported value is BLANK_POLICY.

Constraints:
Allowed Values: BLANK_POLICY

Class com.amazonaws.services.iot.model.ReplaceTopicRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleName

java.lang.String ruleName

The name of the rule.

Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$

topicRulePayload

TopicRulePayload topicRulePayload

The rule payload.

Class com.amazonaws.services.iot.model.RepublishAction extends java.lang.Object implements Serializable

Serialized Fields

qos

java.lang.Integer qos

The Quality of Service (QoS) level to use when republishing messages. The default value is 0.

Constraints:
Range: 0 - 1

roleArn

java.lang.String roleArn

The ARN of the IAM role that grants access.

topic

java.lang.String topic

The name of the MQTT topic.

Class com.amazonaws.services.iot.model.ResourceAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

resourceArn

java.lang.String resourceArn

The ARN of the resource that caused the exception.

resourceId

java.lang.String resourceId

The ID of the resource that caused the exception.

Class com.amazonaws.services.iot.model.ResourceIdentifier extends java.lang.Object implements Serializable

Serialized Fields

account

java.lang.String account

The account with which the resource is associated.

Constraints:
Length: 12 - 12
Pattern: [0-9]+

caCertificateId

java.lang.String caCertificateId

The ID of the CA certificate used to authorize the certificate.

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

clientId

java.lang.String clientId

The client ID.

cognitoIdentityPoolId

java.lang.String cognitoIdentityPoolId

The ID of the Amazon Cognito identity pool.

deviceCertificateId

java.lang.String deviceCertificateId

The ID of the certificate attached to the resource.

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

iamRoleArn

java.lang.String iamRoleArn

The ARN of the IAM role that has overly permissive actions.

Constraints:
Length: 20 - 2048

policyVersionIdentifier

PolicyVersionIdentifier policyVersionIdentifier

The version of the policy associated with the resource.

roleAliasArn

java.lang.String roleAliasArn

The ARN of the role alias that has overly permissive actions.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.iot.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.ResourceRegistrationFailureException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.RetryCriteria extends java.lang.Object implements Serializable

Serialized Fields

failureType

java.lang.String failureType

The type of job execution failures that can initiate a job retry.

Constraints:
Allowed Values: FAILED, TIMED_OUT, ALL

numberOfRetries

java.lang.Integer numberOfRetries

The number of retries allowed for a failure type for the job.

Constraints:
Range: 0 - 10

Class com.amazonaws.services.iot.model.RoleAliasDescription extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The UNIX timestamp of when the role alias was created.

credentialDurationSeconds

java.lang.Integer credentialDurationSeconds

The number of seconds for which the credential is valid.

Constraints:
Range: 900 - 43200

lastModifiedDate

java.util.Date lastModifiedDate

The UNIX timestamp of when the role alias was last modified.

owner

java.lang.String owner

The role alias owner.

Constraints:
Length: 12 - 12
Pattern: [0-9]+

roleAlias

java.lang.String roleAlias

The role alias.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

roleAliasArn

java.lang.String roleAliasArn

The ARN of the role alias.

Constraints:
Length: 1 - 2048

roleArn

java.lang.String roleArn

The role ARN.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.iot.model.S3Action extends java.lang.Object implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The Amazon S3 bucket.

cannedAcl

java.lang.String cannedAcl

The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs.

Constraints:
Allowed Values: private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control, log-delivery-write

key

java.lang.String key

The object key. For more information, see Actions, resources, and condition keys for Amazon S3.

roleArn

java.lang.String roleArn

The ARN of the IAM role that grants access.

Class com.amazonaws.services.iot.model.S3Destination extends java.lang.Object implements Serializable

Serialized Fields

bucket

java.lang.String bucket

The S3 bucket that contains the updated firmware.

Constraints:
Length: 1 -

prefix

java.lang.String prefix

The S3 prefix.

Class com.amazonaws.services.iot.model.S3Location extends java.lang.Object implements Serializable

Serialized Fields

bucket

java.lang.String bucket

The S3 bucket.

Constraints:
Length: 1 -

key

java.lang.String key

The S3 key.

Constraints:
Length: 1 -

version

java.lang.String version

The S3 bucket version.

Class com.amazonaws.services.iot.model.SalesforceAction extends java.lang.Object implements Serializable

Serialized Fields

token

java.lang.String token

The token used to authenticate access to the Salesforce IoT Cloud Input Stream. The token is available from the Salesforce IoT Cloud platform after creation of the Input Stream.

Constraints:
Length: 40 -

url

java.lang.String url

The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available from the Salesforce IoT Cloud platform after creation of the Input Stream.

Constraints:
Length: - 2000
Pattern: https://ingestion-[a-zA-Z0-9]{1,12}\.[a-zA-Z0-9]+\.((sfdc- matrix\.net)|(sfdcnow\.com))/streams/\w{1,20}/\w{1,20}/event

Class com.amazonaws.services.iot.model.ScheduledAuditMetadata extends java.lang.Object implements Serializable

Serialized Fields

dayOfMonth

java.lang.String dayOfMonth

The day of the month on which the scheduled audit is run (if the frequency is "MONTHLY"). If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.

Constraints:
Pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$

dayOfWeek

java.lang.String dayOfWeek

The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY").

Constraints:
Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT

frequency

java.lang.String frequency

How often the scheduled audit occurs.

Constraints:
Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY

scheduledAuditArn

java.lang.String scheduledAuditArn

The ARN of the scheduled audit.

scheduledAuditName

java.lang.String scheduledAuditName

The name of the scheduled audit.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.SearchIndexRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

indexName

java.lang.String indexName

The search index name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

The token used to get the next set of results, or null if there are no additional results.

queryString

java.lang.String queryString

The search query string. For more information about the search query syntax, see Query syntax.

Constraints:
Length: 1 -

queryVersion

java.lang.String queryVersion

The query version.

Class com.amazonaws.services.iot.model.SearchIndexResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token used to get the next set of results, or null if there are no additional results.

thingGroups

java.util.List<ThingGroupDocument> thingGroups

The thing groups that match the search query.

things

java.util.List<ThingDocument> things

The things that match the search query.

Class com.amazonaws.services.iot.model.SecurityProfileIdentifier extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The ARN of the security profile.

name

java.lang.String name

The name you've given to the security profile.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.SecurityProfileTarget extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The ARN of the security profile.

Class com.amazonaws.services.iot.model.SecurityProfileTargetMapping extends java.lang.Object implements Serializable

Serialized Fields

securityProfileIdentifier

SecurityProfileIdentifier securityProfileIdentifier

Information that identifies the security profile.

target

SecurityProfileTarget target

Information about the target (thing group) associated with the security profile.

Class com.amazonaws.services.iot.model.ServerCertificateSummary extends java.lang.Object implements Serializable

Serialized Fields

serverCertificateArn

java.lang.String serverCertificateArn

The ARN of the server certificate.

Constraints:
Length: 1 - 2048
Pattern: arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-| isob-)?[a-z]{4,9}-\d{1}:\d{12}:certificate/[a-zA-Z0-9/-]+

serverCertificateStatus

java.lang.String serverCertificateStatus

The status of the server certificate.

Constraints:
Allowed Values: INVALID, VALID

serverCertificateStatusDetail

java.lang.String serverCertificateStatusDetail

Details that explain the status of the server certificate.

Class com.amazonaws.services.iot.model.ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.SetDefaultAuthorizerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

authorizerName

java.lang.String authorizerName

The authorizer name.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

Class com.amazonaws.services.iot.model.SetDefaultAuthorizerResult extends java.lang.Object implements Serializable

Serialized Fields

authorizerArn

java.lang.String authorizerArn

The authorizer ARN.

Constraints:
Length: - 2048

authorizerName

java.lang.String authorizerName

The authorizer name.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

Class com.amazonaws.services.iot.model.SetDefaultPolicyVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

java.lang.String policyName

The policy name.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

policyVersionId

java.lang.String policyVersionId

The policy version ID.

Constraints:
Pattern: [0-9]+

Class com.amazonaws.services.iot.model.SetLoggingOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loggingOptionsPayload

LoggingOptionsPayload loggingOptionsPayload

The logging options payload.

Class com.amazonaws.services.iot.model.SetV2LoggingLevelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

logLevel

java.lang.String logLevel

The log level.

Constraints:
Allowed Values: DEBUG, INFO, ERROR, WARN, DISABLED

logTarget

LogTarget logTarget

The log target.

Class com.amazonaws.services.iot.model.SetV2LoggingOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

defaultLogLevel

java.lang.String defaultLogLevel

The default logging level.

Constraints:
Allowed Values: DEBUG, INFO, ERROR, WARN, DISABLED

disableAllLogs

java.lang.Boolean disableAllLogs

If true all logs are disabled. The default is false.

roleArn

java.lang.String roleArn

The ARN of the role that allows IoT to write to Cloudwatch logs.

Class com.amazonaws.services.iot.model.SigningProfileParameter extends java.lang.Object implements Serializable

Serialized Fields

certificateArn

java.lang.String certificateArn

Certificate ARN.

certificatePathOnDevice

java.lang.String certificatePathOnDevice

The location of the code-signing certificate on your device.

platform

java.lang.String platform

The hardware platform of your device.

Class com.amazonaws.services.iot.model.SigV4Authorization extends java.lang.Object implements Serializable

Serialized Fields

roleArn

java.lang.String roleArn

The ARN of the signing role.

serviceName

java.lang.String serviceName

The service name to use while signing with Sig V4.

signingRegion

java.lang.String signingRegion

The signing region.

Class com.amazonaws.services.iot.model.SnsAction extends java.lang.Object implements Serializable

Serialized Fields

messageFormat

java.lang.String messageFormat

(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

Constraints:
Allowed Values: RAW, JSON

roleArn

java.lang.String roleArn

The ARN of the IAM role that grants access.

targetArn

java.lang.String targetArn

The ARN of the SNS topic.

Class com.amazonaws.services.iot.model.SqlParseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.SqsAction extends java.lang.Object implements Serializable

Serialized Fields

queueUrl

java.lang.String queueUrl

The URL of the Amazon SQS queue.

roleArn

java.lang.String roleArn

The ARN of the IAM role that grants access.

useBase64

java.lang.Boolean useBase64

Specifies whether to use Base64 encoding.

Class com.amazonaws.services.iot.model.StartAuditMitigationActionsTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

auditCheckToActionsMapping

java.util.Map<java.lang.String,java.util.List<java.lang.String>> auditCheckToActionsMapping

For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.

clientRequestToken

java.lang.String clientRequestToken

Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

target

AuditMitigationActionsTaskTarget target

Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a specific set of findings.

taskId

java.lang.String taskId

A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.StartAuditMitigationActionsTaskResult extends java.lang.Object implements Serializable

Serialized Fields

taskId

java.lang.String taskId

The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.StartDetectMitigationActionsTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

actions

java.util.List<java.lang.String> actions

The actions to be performed when a device has unexpected behavior.

clientRequestToken

java.lang.String clientRequestToken

Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

includeOnlyActiveViolations

java.lang.Boolean includeOnlyActiveViolations

Specifies to list only active violations.

includeSuppressedAlerts

java.lang.Boolean includeSuppressedAlerts

Specifies to include suppressed alerts.

target

DetectMitigationActionsTaskTarget target

Specifies the ML Detect findings to which the mitigation actions are applied.

taskId

java.lang.String taskId

The unique identifier of the task.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

violationEventOccurrenceRange

ViolationEventOccurrenceRange violationEventOccurrenceRange

Specifies the time period of which violation events occurred between.

Class com.amazonaws.services.iot.model.StartDetectMitigationActionsTaskResult extends java.lang.Object implements Serializable

Serialized Fields

taskId

java.lang.String taskId

The unique identifier of the task.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.StartOnDemandAuditTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

targetCheckNames

java.util.List<java.lang.String> targetCheckNames

Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.

Class com.amazonaws.services.iot.model.StartOnDemandAuditTaskResult extends java.lang.Object implements Serializable

Serialized Fields

taskId

java.lang.String taskId

The ID of the on-demand audit you started.

Constraints:
Length: 1 - 40
Pattern: [a-zA-Z0-9\-]+

Class com.amazonaws.services.iot.model.StartSigningJobParameter extends java.lang.Object implements Serializable

Serialized Fields

destination

Destination destination

The location to write the code-signed file.

signingProfileName

java.lang.String signingProfileName

The code-signing profile name.

signingProfileParameter

SigningProfileParameter signingProfileParameter

Describes the code-signing profile.

Class com.amazonaws.services.iot.model.StartThingRegistrationTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

inputFileBucket

java.lang.String inputFileBucket

The S3 bucket that contains the input file.

Constraints:
Length: 3 - 256
Pattern: [a-zA-Z0-9._-]+

inputFileKey

java.lang.String inputFileKey

The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains the parameter values to provision one device (thing).

Constraints:
Length: 1 - 1024
Pattern: [a-zA-Z0-9!_.*'()-\/]+

roleArn

java.lang.String roleArn

The IAM role ARN that grants permission the input file.

Constraints:
Length: 20 - 2048

templateBody

java.lang.String templateBody

The provisioning template.

Constraints:
Length: 0 - 10240
Pattern: [\s\S]*

Class com.amazonaws.services.iot.model.StartThingRegistrationTaskResult extends java.lang.Object implements Serializable

Serialized Fields

taskId

java.lang.String taskId

The bulk thing provisioning task ID.

Constraints:
Length: - 40

Class com.amazonaws.services.iot.model.StatisticalThreshold extends java.lang.Object implements Serializable

Serialized Fields

statistic

java.lang.String statistic

The percentile that resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below ( comparisonOperator) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.

Constraints:
Pattern: (p0|p0\.1|p0\.01|p1|p10|p50|p90|p99|p99\.9|p99\.99|p100)

Class com.amazonaws.services.iot.model.Statistics extends java.lang.Object implements Serializable

Serialized Fields

average

java.lang.Double average

The average of the aggregated field values.

count

java.lang.Integer count

The count of things that match the query string criteria and contain a valid aggregation field value.

maximum

java.lang.Double maximum

The maximum aggregated field value.

minimum

java.lang.Double minimum

The minimum aggregated field value.

stdDeviation

java.lang.Double stdDeviation

The standard deviation of the aggregated field values.

sum

java.lang.Double sum

The sum of the aggregated field values.

sumOfSquares

java.lang.Double sumOfSquares

The sum of the squares of the aggregated field values.

variance

java.lang.Double variance

The variance of the aggregated field values.

Class com.amazonaws.services.iot.model.StepFunctionsAction extends java.lang.Object implements Serializable

Serialized Fields

executionNamePrefix

java.lang.String executionNamePrefix

(Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.

roleArn

java.lang.String roleArn

The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").

stateMachineName

java.lang.String stateMachineName

The name of the Step Functions state machine whose execution will be started.

Class com.amazonaws.services.iot.model.StopThingRegistrationTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskId

java.lang.String taskId

The bulk thing provisioning task ID.

Constraints:
Length: - 40

Class com.amazonaws.services.iot.model.StopThingRegistrationTaskResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.Stream extends java.lang.Object implements Serializable

Serialized Fields

fileId

java.lang.Integer fileId

The ID of a file associated with a stream.

Constraints:
Range: 0 - 255

streamId

java.lang.String streamId

The stream ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.StreamFile extends java.lang.Object implements Serializable

Serialized Fields

fileId

java.lang.Integer fileId

The file ID.

Constraints:
Range: 0 - 255

s3Location

S3Location s3Location

The location of the file in S3.

Class com.amazonaws.services.iot.model.StreamInfo extends java.lang.Object implements Serializable

Serialized Fields

createdAt

java.util.Date createdAt

The date when the stream was created.

description

java.lang.String description

The description of the stream.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

files

java.util.List<StreamFile> files

The files to stream.

lastUpdatedAt

java.util.Date lastUpdatedAt

The date when the stream was last updated.

roleArn

java.lang.String roleArn

An IAM role IoT assumes to access your S3 files.

Constraints:
Length: 20 - 2048

streamArn

java.lang.String streamArn

The stream ARN.

streamId

java.lang.String streamId

The stream ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

streamVersion

java.lang.Integer streamVersion

The stream version.

Constraints:
Range: 0 - 65535

Class com.amazonaws.services.iot.model.StreamSummary extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

A description of the stream.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

streamArn

java.lang.String streamArn

The stream ARN.

streamId

java.lang.String streamId

The stream ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

streamVersion

java.lang.Integer streamVersion

The stream version.

Constraints:
Range: 0 - 65535

Class com.amazonaws.services.iot.model.Tag extends java.lang.Object implements Serializable

Serialized Fields

key

java.lang.String key

The tag's key.

Constraints:
Length: 1 - 128
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

value

java.lang.String value

The tag's value.

Constraints:
Length: 0 - 256

Class com.amazonaws.services.iot.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The ARN of the resource.

tags

java.util.List<Tag> tags

The new or modified tags for the resource.

Class com.amazonaws.services.iot.model.TagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.TaskAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.TaskStatistics extends java.lang.Object implements Serializable

Serialized Fields

canceledChecks

java.lang.Integer canceledChecks

The number of checks that did not run because the audit was canceled.

compliantChecks

java.lang.Integer compliantChecks

The number of checks that found compliant resources.

failedChecks

java.lang.Integer failedChecks

The number of checks.

inProgressChecks

java.lang.Integer inProgressChecks

The number of checks in progress.

nonCompliantChecks

java.lang.Integer nonCompliantChecks

The number of checks that found noncompliant resources.

totalChecks

java.lang.Integer totalChecks

The number of checks in this audit.

waitingForDataCollectionChecks

java.lang.Integer waitingForDataCollectionChecks

The number of checks waiting for data collection.

Class com.amazonaws.services.iot.model.TaskStatisticsForAuditCheck extends java.lang.Object implements Serializable

Serialized Fields

canceledFindingsCount

java.lang.Long canceledFindingsCount

The number of findings to which the mitigation action task was canceled when applied.

failedFindingsCount

java.lang.Long failedFindingsCount

The number of findings for which at least one of the actions failed when applied.

skippedFindingsCount

java.lang.Long skippedFindingsCount

The number of findings skipped because of filter conditions provided in the parameters to the command.

succeededFindingsCount

java.lang.Long succeededFindingsCount

The number of findings for which all mitigation actions succeeded when applied.

totalFindingsCount

java.lang.Long totalFindingsCount

The total number of findings to which a task is being applied.

Class com.amazonaws.services.iot.model.TermsAggregation extends java.lang.Object implements Serializable

Serialized Fields

maxBuckets

java.lang.Integer maxBuckets

The number of buckets to return in the response. Default to 10.

Constraints:
Range: 1 - 10000

Class com.amazonaws.services.iot.model.TestAuthorizationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

authInfos

java.util.List<AuthInfo> authInfos

A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.

clientId

java.lang.String clientId

The MQTT client ID.

cognitoIdentityPoolId

java.lang.String cognitoIdentityPoolId

The Cognito identity pool ID.

policyNamesToAdd

java.util.List<java.lang.String> policyNamesToAdd

When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

policyNamesToSkip

java.util.List<java.lang.String> policyNamesToSkip

When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

principal

java.lang.String principal

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

Class com.amazonaws.services.iot.model.TestAuthorizationResult extends java.lang.Object implements Serializable

Serialized Fields

authResults

java.util.List<AuthResult> authResults

The authentication results.

Class com.amazonaws.services.iot.model.TestInvokeAuthorizerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

authorizerName

java.lang.String authorizerName

The custom authorizer name.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

httpContext

HttpContext httpContext

Specifies a test HTTP authorization request.

mqttContext

MqttContext mqttContext

Specifies a test MQTT authorization request.

tlsContext

TlsContext tlsContext

Specifies a test TLS authorization request.

token

java.lang.String token

The token returned by your custom authentication service.

Constraints:
Length: 1 - 6144
Pattern: [\s\S]*

tokenSignature

java.lang.String tokenSignature

The signature made with the token and your custom authentication service's private key. This value must be Base-64-encoded.

Constraints:
Length: 1 - 2560
Pattern: [A-Za-z0-9+/]+={0,2}

Class com.amazonaws.services.iot.model.TestInvokeAuthorizerResult extends java.lang.Object implements Serializable

Serialized Fields

disconnectAfterInSeconds

java.lang.Integer disconnectAfterInSeconds

The number of seconds after which the connection is terminated.

isAuthenticated

java.lang.Boolean isAuthenticated

True if the token is authenticated, otherwise false.

policyDocuments

java.util.List<java.lang.String> policyDocuments

IAM policy documents.

principalId

java.lang.String principalId

The principal ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9]+

refreshAfterInSeconds

java.lang.Integer refreshAfterInSeconds

The number of seconds after which the temporary credentials are refreshed.

Class com.amazonaws.services.iot.model.ThingAttribute extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

A list of thing attributes which are name-value pairs.

thingArn

java.lang.String thingArn

The thing ARN.

thingName

java.lang.String thingName

The name of the thing.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingTypeName

java.lang.String thingTypeName

The name of the thing type, if the thing has been associated with a type.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

version

java.lang.Long version

The version of the thing record in the registry.

Class com.amazonaws.services.iot.model.ThingConnectivity extends java.lang.Object implements Serializable

Serialized Fields

connected

java.lang.Boolean connected

True if the thing is connected to the Amazon Web Services IoT Core service; false if it is not connected.

disconnectReason

java.lang.String disconnectReason

The reason why the client is disconnected. If the thing has been disconnected for approximately an hour, the disconnectReason value might be missing.

timestamp

java.lang.Long timestamp

The epoch time (in milliseconds) when the thing last connected or disconnected. If the thing has been disconnected for approximately an hour, the time value might be missing.

Class com.amazonaws.services.iot.model.ThingDocument extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

The attributes.

connectivity

ThingConnectivity connectivity

Indicates whether the thing is connected to the Amazon Web Services IoT Core service.

deviceDefender

java.lang.String deviceDefender

Contains Device Defender data.

For more information about Device Defender, see Device Defender.

shadow

java.lang.String shadow

The unnamed shadow and named shadow.

For more information about shadows, see IoT Device Shadow service.

thingGroupNames

java.util.List<java.lang.String> thingGroupNames

Thing group names.

thingId

java.lang.String thingId

The thing ID.

thingName

java.lang.String thingName

The thing name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingTypeName

java.lang.String thingTypeName

The thing type name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.ThingGroupDocument extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

The thing group attributes.

parentGroupNames

java.util.List<java.lang.String> parentGroupNames

Parent group names.

thingGroupDescription

java.lang.String thingGroupDescription

The thing group description.

Constraints:
Length: - 2028
Pattern: [\p{Graph}\x20]*

thingGroupId

java.lang.String thingGroupId

The thing group ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+

thingGroupName

java.lang.String thingGroupName

The thing group name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.ThingGroupIndexingConfiguration extends java.lang.Object implements Serializable

Serialized Fields

customFields

java.util.List<Field> customFields

A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.

Contains custom field names and their data type.

managedFields

java.util.List<Field> managedFields

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

thingGroupIndexingMode

java.lang.String thingGroupIndexingMode

Thing group indexing mode.

Constraints:
Allowed Values: OFF, ON

Class com.amazonaws.services.iot.model.ThingGroupMetadata extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The UNIX timestamp of when the thing group was created.

parentGroupName

java.lang.String parentGroupName

The parent thing group name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

rootToParentThingGroups

java.util.List<GroupNameAndArn> rootToParentThingGroups

The root parent thing group.

Class com.amazonaws.services.iot.model.ThingGroupProperties extends java.lang.Object implements Serializable

Serialized Fields

attributePayload

AttributePayload attributePayload

The thing group attributes in JSON format.

thingGroupDescription

java.lang.String thingGroupDescription

The thing group description.

Constraints:
Length: - 2028
Pattern: [\p{Graph}\x20]*

Class com.amazonaws.services.iot.model.ThingIndexingConfiguration extends java.lang.Object implements Serializable

Serialized Fields

customFields

java.util.List<Field> customFields

Contains custom field names and their data type.

deviceDefenderIndexingMode

java.lang.String deviceDefenderIndexingMode

Device Defender indexing mode. Valid values are:

• VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF.

• OFF - Device Defender indexing is disabled.

For more information about Device Defender violations, see Device Defender Detect.

Constraints:
Allowed Values: OFF, VIOLATIONS

filter

IndexingFilter filter

Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in filter.

managedFields

java.util.List<Field> managedFields

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

namedShadowIndexingMode

java.lang.String namedShadowIndexingMode

Named shadow indexing mode. Valid values are:

• ON – Your thing index contains named shadow. To enable thing named shadow indexing, namedShadowIndexingMode must not be set to OFF.

• OFF - Named shadow indexing is disabled.

For more information about Shadows, see IoT Device Shadow service.

Constraints:
Allowed Values: OFF, ON

thingConnectivityIndexingMode

java.lang.String thingConnectivityIndexingMode

Thing connectivity indexing mode. Valid values are:

• STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.

• OFF - Thing connectivity status indexing is disabled.

Constraints:
Allowed Values: OFF, STATUS

thingIndexingMode

java.lang.String thingIndexingMode

Thing indexing mode. Valid values are:

• REGISTRY – Your thing index contains registry data only.

• REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.

• OFF - Thing indexing is disabled.

Constraints:
Allowed Values: OFF, REGISTRY, REGISTRY_AND_SHADOW

Class com.amazonaws.services.iot.model.ThingTypeDefinition extends java.lang.Object implements Serializable

Serialized Fields

thingTypeArn

java.lang.String thingTypeArn

The thing type ARN.

thingTypeMetadata

ThingTypeMetadata thingTypeMetadata

The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when it was deprecated.

thingTypeName

java.lang.String thingTypeName

The name of the thing type.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingTypeProperties

ThingTypeProperties thingTypeProperties

The ThingTypeProperties for the thing type.

Class com.amazonaws.services.iot.model.ThingTypeMetadata extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The date and time when the thing type was created.

deprecated

java.lang.Boolean deprecated

Whether the thing type is deprecated. If true, no new things could be associated with this type.

deprecationDate

java.util.Date deprecationDate

The date and time when the thing type was deprecated.

Class com.amazonaws.services.iot.model.ThingTypeProperties extends java.lang.Object implements Serializable

Serialized Fields

searchableAttributes

java.util.List<java.lang.String> searchableAttributes

A list of searchable thing attribute names.

thingTypeDescription

java.lang.String thingTypeDescription

The description of the thing type.

Constraints:
Length: - 2028
Pattern: [\p{Graph}\x20]*

Class com.amazonaws.services.iot.model.ThrottlingException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.TimeoutConfig extends java.lang.Object implements Serializable

Serialized Fields

inProgressTimeoutInMinutes

java.lang.Long inProgressTimeoutInMinutes

Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

Class com.amazonaws.services.iot.model.TimestreamAction extends java.lang.Object implements Serializable

Serialized Fields

databaseName

java.lang.String databaseName

The name of an Amazon Timestream database.

dimensions

java.util.List<TimestreamDimension> dimensions

Metadata attributes of the time series that are written in each measure record.

roleArn

java.lang.String roleArn

The ARN of the role that grants permission to write to the Amazon Timestream database table.

tableName

java.lang.String tableName

The name of the database table into which to write the measure records.

timestamp

TimestreamTimestamp timestamp

Specifies an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column.

You can use this property to specify the value and the precision of the Timestream record's timestamp. You can specify a value from the message payload or a value computed by a substitution template.

If omitted, the topic rule action assigns the timestamp, in milliseconds, at the time it processed the rule.

Class com.amazonaws.services.iot.model.TimestreamDimension extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The metadata dimension name. This is the name of the column in the Amazon Timestream database table record.

Dimensions cannot be named: measure_name, measure_value, or time. These names are reserved. Dimension names cannot start with ts_ or measure_value and they cannot contain the colon ( :) character.

value

java.lang.String value

The value to write in this column of the database record.

Class com.amazonaws.services.iot.model.TimestreamTimestamp extends java.lang.Object implements Serializable

Serialized Fields

unit

java.lang.String unit

The precision of the timestamp value that results from the expression described in value.

Valid values: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS. The default is MILLISECONDS.

value

java.lang.String value

An expression that returns a long epoch time value.

Class com.amazonaws.services.iot.model.TlsContext extends java.lang.Object implements Serializable

Serialized Fields

serverName

java.lang.String serverName

The value of the serverName key in a TLS authorization request.

Constraints:
Length: 1 - 253
Pattern: [\s\S]*

Class com.amazonaws.services.iot.model.TopicRule extends java.lang.Object implements Serializable

Serialized Fields

actions

java.util.List<Action> actions

The actions associated with the rule.

awsIotSqlVersion

java.lang.String awsIotSqlVersion

The version of the SQL rules engine to use when evaluating the rule.

createdAt

java.util.Date createdAt

The date and time the rule was created.

description

java.lang.String description

The description of the rule.

errorAction

Action errorAction

The action to perform when an error occurs.

ruleDisabled

java.lang.Boolean ruleDisabled

Specifies whether the rule is disabled.

ruleName

java.lang.String ruleName

The name of the rule.

Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$

sql

java.lang.String sql

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

Class com.amazonaws.services.iot.model.TopicRuleDestination extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The topic rule destination URL.

createdAt

java.util.Date createdAt

The date and time when the topic rule destination was created.

httpUrlProperties

HttpUrlDestinationProperties httpUrlProperties

Properties of the HTTP URL.

lastUpdatedAt

java.util.Date lastUpdatedAt

The date and time when the topic rule destination was last updated.

status

java.lang.String status

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Constraints:
Allowed Values: ENABLED, IN_PROGRESS, DISABLED, ERROR, DELETING

statusReason

java.lang.String statusReason

Additional details or reason why the topic rule destination is in the current status.

vpcProperties

VpcDestinationProperties vpcProperties

Properties of the virtual private cloud (VPC) connection.

Class com.amazonaws.services.iot.model.TopicRuleDestinationConfiguration extends java.lang.Object implements Serializable

Serialized Fields

httpUrlConfiguration

HttpUrlDestinationConfiguration httpUrlConfiguration

Configuration of the HTTP URL.

vpcConfiguration

VpcDestinationConfiguration vpcConfiguration

Configuration of the virtual private cloud (VPC) connection.

Class com.amazonaws.services.iot.model.TopicRuleDestinationSummary extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The topic rule destination ARN.

createdAt

java.util.Date createdAt

The date and time when the topic rule destination was created.

httpUrlSummary

HttpUrlDestinationSummary httpUrlSummary

Information about the HTTP URL.

lastUpdatedAt

java.util.Date lastUpdatedAt

The date and time when the topic rule destination was last updated.

status

java.lang.String status

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Constraints:
Allowed Values: ENABLED, IN_PROGRESS, DISABLED, ERROR, DELETING

statusReason

java.lang.String statusReason

The reason the topic rule destination is in the current status.

vpcDestinationSummary

VpcDestinationSummary vpcDestinationSummary

Information about the virtual private cloud (VPC) connection.

Class com.amazonaws.services.iot.model.TopicRuleListItem extends java.lang.Object implements Serializable

Serialized Fields

createdAt

java.util.Date createdAt

The date and time the rule was created.

ruleArn

java.lang.String ruleArn

The rule ARN.

ruleDisabled

java.lang.Boolean ruleDisabled

Specifies whether the rule is disabled.

ruleName

java.lang.String ruleName

The name of the rule.

Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_]+$

topicPattern

java.lang.String topicPattern

The pattern for the topic names that apply.

Class com.amazonaws.services.iot.model.TopicRulePayload extends java.lang.Object implements Serializable

Serialized Fields

actions

java.util.List<Action> actions

The actions associated with the rule.

awsIotSqlVersion

java.lang.String awsIotSqlVersion

The version of the SQL rules engine to use when evaluating the rule.

description

java.lang.String description

The description of the rule.

errorAction

Action errorAction

The action to take when an error occurs.

ruleDisabled

java.lang.Boolean ruleDisabled

Specifies whether the rule is disabled.

sql

java.lang.String sql

The SQL statement used to query the topic. For more information, see IoT SQL Reference in the IoT Developer Guide.

Class com.amazonaws.services.iot.model.TransferAlreadyCompletedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.TransferCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

java.lang.String certificateId

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

targetAwsAccount

java.lang.String targetAwsAccount

The Amazon Web Services account.

Constraints:
Length: 12 - 12
Pattern: [0-9]+

transferMessage

java.lang.String transferMessage

The transfer message.

Constraints:
Length: - 128
Pattern: [\s\S]*

Class com.amazonaws.services.iot.model.TransferCertificateResult extends java.lang.Object implements Serializable

Serialized Fields

transferredCertificateArn

java.lang.String transferredCertificateArn

The ARN of the certificate.

Class com.amazonaws.services.iot.model.TransferConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.TransferData extends java.lang.Object implements Serializable

Serialized Fields

acceptDate

java.util.Date acceptDate

The date the transfer was accepted.

rejectDate

java.util.Date rejectDate

The date the transfer was rejected.

rejectReason

java.lang.String rejectReason

The reason why the transfer was rejected.

Constraints:
Length: - 128
Pattern: [\s\S]*

transferDate

java.util.Date transferDate

The date the transfer took place.

transferMessage

java.lang.String transferMessage

The transfer message.

Constraints:
Length: - 128
Pattern: [\s\S]*

Class com.amazonaws.services.iot.model.UnauthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The ARN of the resource.

tagKeys

java.util.List<java.lang.String> tagKeys

A list of the keys of the tags to be removed from the resource.

Class com.amazonaws.services.iot.model.UntagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.UpdateAccountAuditConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

auditCheckConfigurations

java.util.Map<java.lang.String,AuditCheckConfiguration> auditCheckConfigurations

Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are currently enabled.

Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.

You cannot disable a check if it's used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.

On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at least one enabled check.

auditNotificationTargetConfigurations

java.util.Map<java.lang.String,AuditNotificationTarget> auditNotificationTargetConfigurations

Information about the targets to which audit notifications are sent.

roleArn

java.lang.String roleArn

The Amazon Resource Name (ARN) of the role that grants permission to IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.iot.model.UpdateAccountAuditConfigurationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.UpdateAuditSuppressionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

checkName

java.lang.String checkName

An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

description

java.lang.String description

The description of the audit suppression.

Constraints:
Length: - 1000
Pattern: [\p{Graph}\x20]*

expirationDate

java.util.Date expirationDate

The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.

resourceIdentifier

ResourceIdentifier resourceIdentifier

Information that identifies the noncompliant resource.

suppressIndefinitely

java.lang.Boolean suppressIndefinitely

Indicates whether a suppression should exist indefinitely or not.

Class com.amazonaws.services.iot.model.UpdateAuditSuppressionResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.UpdateAuthorizerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

authorizerFunctionArn

java.lang.String authorizerFunctionArn

The ARN of the authorizer's Lambda function.

Constraints:
Length: - 2048
Pattern: [\s\S]*

authorizerName

java.lang.String authorizerName

The authorizer name.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

enableCachingForHttp

java.lang.Boolean enableCachingForHttp

When true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection.

status

java.lang.String status

The status of the update authorizer request.

Constraints:
Allowed Values: ACTIVE, INACTIVE

tokenKeyName

java.lang.String tokenKeyName

The key used to extract the token from the HTTP headers.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

tokenSigningPublicKeys

java.util.Map<java.lang.String,java.lang.String> tokenSigningPublicKeys

The public keys used to verify the token signature.

Class com.amazonaws.services.iot.model.UpdateAuthorizerResult extends java.lang.Object implements Serializable

Serialized Fields

authorizerArn

java.lang.String authorizerArn

The authorizer ARN.

Constraints:
Length: - 2048

authorizerName

java.lang.String authorizerName

The authorizer name.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

Class com.amazonaws.services.iot.model.UpdateBillingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

billingGroupName

java.lang.String billingGroupName

The name of the billing group.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

billingGroupProperties

BillingGroupProperties billingGroupProperties

The properties of the billing group.

expectedVersion

java.lang.Long expectedVersion

The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the UpdateBillingGroup request is rejected with a VersionConflictException.

Class com.amazonaws.services.iot.model.UpdateBillingGroupResult extends java.lang.Object implements Serializable

Serialized Fields

version

java.lang.Long version

The latest version of the billing group.

Class com.amazonaws.services.iot.model.UpdateCACertificateParams extends java.lang.Object implements Serializable

Serialized Fields

action

java.lang.String action

The action that you want to apply to the CA certificate. The only supported value is DEACTIVATE.

Constraints:
Allowed Values: DEACTIVATE

Class com.amazonaws.services.iot.model.UpdateCACertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

java.lang.String certificateId

The CA certificate identifier.

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

newAutoRegistrationStatus

java.lang.String newAutoRegistrationStatus

The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".

Constraints:
Allowed Values: ENABLE, DISABLE

newStatus

java.lang.String newStatus

The updated status of the CA certificate.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

Constraints:
Allowed Values: ACTIVE, INACTIVE

registrationConfig

RegistrationConfig registrationConfig

Information about the registration configuration.

removeAutoRegistration

java.lang.Boolean removeAutoRegistration

If true, removes auto registration.

Class com.amazonaws.services.iot.model.UpdateCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

java.lang.String certificateId

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

newStatus

java.lang.String newStatus

The new status.

Note: Setting the status to PENDING_TRANSFER or PENDING_ACTIVATION will result in an exception being thrown. PENDING_TRANSFER and PENDING_ACTIVATION are statuses used internally by IoT. They are not intended for developer use.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

Constraints:
Allowed Values: ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, REGISTER_INACTIVE, PENDING_ACTIVATION

Class com.amazonaws.services.iot.model.UpdateCustomMetricRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

displayName

java.lang.String displayName

Field represents a friendly name in the console for the custom metric, it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.

Constraints:
Length: - 128
Pattern: [\p{Graph}\x20]*

metricName

java.lang.String metricName

The name of the custom metric. Cannot be updated.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.UpdateCustomMetricResult extends java.lang.Object implements Serializable

Serialized Fields

creationDate

java.util.Date creationDate

The creation date of the custom metric in milliseconds since epoch.

displayName

java.lang.String displayName

A friendly name in the console for the custom metric

Constraints:
Length: - 128
Pattern: [\p{Graph}\x20]*

lastModifiedDate

java.util.Date lastModifiedDate

The time the custom metric was last modified in milliseconds since epoch.

metricArn

java.lang.String metricArn

The Amazon Resource Number (ARN) of the custom metric.

metricName

java.lang.String metricName

The name of the custom metric.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

metricType

java.lang.String metricType

The type of the custom metric.

The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

Constraints:
Allowed Values: string-list, ip-address-list, number-list, number

Class com.amazonaws.services.iot.model.UpdateDeviceCertificateParams extends java.lang.Object implements Serializable

Serialized Fields

action

java.lang.String action

The action that you want to apply to the device certificate. The only supported value is DEACTIVATE.

Constraints:
Allowed Values: DEACTIVATE

Class com.amazonaws.services.iot.model.UpdateDimensionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

java.lang.String name

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

stringValues

java.util.List<java.lang.String> stringValues

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

Class com.amazonaws.services.iot.model.UpdateDimensionResult extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN)of the created dimension.

creationDate

java.util.Date creationDate

The date and time, in milliseconds since epoch, when the dimension was initially created.

lastModifiedDate

java.util.Date lastModifiedDate

The date and time, in milliseconds since epoch, when the dimension was most recently updated.

name

java.lang.String name

A unique identifier for the dimension.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

stringValues

java.util.List<java.lang.String> stringValues

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

type

java.lang.String type

The type of the dimension.

Constraints:
Allowed Values: TOPIC_FILTER

Class com.amazonaws.services.iot.model.UpdateDomainConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

authorizerConfig

AuthorizerConfig authorizerConfig

An object that specifies the authorization service for a domain.

domainConfigurationName

java.lang.String domainConfigurationName

The name of the domain configuration to be updated.

Constraints:
Length: 1 - 128
Pattern: [\w.:-]+

domainConfigurationStatus

java.lang.String domainConfigurationStatus

The status to which the domain configuration should be updated.

Constraints:
Allowed Values: ENABLED, DISABLED

removeAuthorizerConfig

java.lang.Boolean removeAuthorizerConfig

Removes the authorization configuration from a domain.

Class com.amazonaws.services.iot.model.UpdateDomainConfigurationResult extends java.lang.Object implements Serializable

Serialized Fields

domainConfigurationArn

java.lang.String domainConfigurationArn

The ARN of the domain configuration that was updated.

domainConfigurationName

java.lang.String domainConfigurationName

The name of the domain configuration that was updated.

Constraints:
Length: 1 - 128
Pattern: [\w.:-]+

Class com.amazonaws.services.iot.model.UpdateDynamicThingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

expectedVersion

java.lang.Long expectedVersion

The expected version of the dynamic thing group to update.

indexName

java.lang.String indexName

The dynamic thing group index to update.

Currently one index is supported: AWS_Things.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

queryString

java.lang.String queryString

The dynamic thing group search query string to update.

Constraints:
Length: 1 -

queryVersion

java.lang.String queryVersion

The dynamic thing group query version to update.

Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.

thingGroupName

java.lang.String thingGroupName

The name of the dynamic thing group to update.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingGroupProperties

ThingGroupProperties thingGroupProperties

The dynamic thing group properties to update.

Class com.amazonaws.services.iot.model.UpdateDynamicThingGroupResult extends java.lang.Object implements Serializable

Serialized Fields

version

java.lang.Long version

The dynamic thing group version.

Class com.amazonaws.services.iot.model.UpdateEventConfigurationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

eventConfigurations

java.util.Map<java.lang.String,Configuration> eventConfigurations

The new event configuration values.

Class com.amazonaws.services.iot.model.UpdateEventConfigurationsResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.UpdateFleetMetricRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aggregationField

java.lang.String aggregationField

The field to aggregate.

Constraints:
Length: 1 -

aggregationType

AggregationType aggregationType

The type of the aggregation query.

description

java.lang.String description

The description of the fleet metric.

Constraints:
Length: - 1024
Pattern: [\p{Graph}\x20]*

expectedVersion

java.lang.Long expectedVersion

The expected version of the fleet metric record in the registry.

indexName

java.lang.String indexName

The name of the index to search.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

metricName

java.lang.String metricName

The name of the fleet metric to update.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_\-\.]+

period

java.lang.Integer period

The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

Constraints:
Range: 60 - 86400

queryString

java.lang.String queryString

The search query string.

Constraints:
Length: 1 -

queryVersion

java.lang.String queryVersion

The version of the query.

unit

java.lang.String unit

Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

Class com.amazonaws.services.iot.model.UpdateIndexingConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

thingGroupIndexingConfiguration

ThingGroupIndexingConfiguration thingGroupIndexingConfiguration

Thing group indexing configuration.

thingIndexingConfiguration

ThingIndexingConfiguration thingIndexingConfiguration

Thing indexing configuration.

Class com.amazonaws.services.iot.model.UpdateIndexingConfigurationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.UpdateJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

abortConfig

AbortConfig abortConfig

Allows you to create criteria to abort a job.

description

java.lang.String description

A short text description of the job.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

jobExecutionsRetryConfig

JobExecutionsRetryConfig jobExecutionsRetryConfig

Allows you to create the criteria to retry a job.

jobExecutionsRolloutConfig

JobExecutionsRolloutConfig jobExecutionsRolloutConfig

Allows you to create a staged rollout of the job.

jobId

java.lang.String jobId

The ID of the job to be updated.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

namespaceId

java.lang.String namespaceId

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+

presignedUrlConfig

PresignedUrlConfig presignedUrlConfig

Configuration information for pre-signed S3 URLs.

timeoutConfig

TimeoutConfig timeoutConfig

Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.

Class com.amazonaws.services.iot.model.UpdateMitigationActionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

actionName

java.lang.String actionName

The friendly name for the mitigation action. You cannot change the name by using UpdateMitigationAction. Instead, you must delete and recreate the mitigation action with the new name.

Constraints:
Length: - 128
Pattern: [a-zA-Z0-9_-]+

actionParams

MitigationActionParams actionParams

Defines the type of action and the parameters for that action.

roleArn

java.lang.String roleArn

The ARN of the IAM role that is used to apply the mitigation action.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.iot.model.UpdateMitigationActionResult extends java.lang.Object implements Serializable

Serialized Fields

actionArn

java.lang.String actionArn

The ARN for the new mitigation action.

actionId

java.lang.String actionId

A unique identifier for the mitigation action.

Class com.amazonaws.services.iot.model.UpdateProvisioningTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

defaultVersionId

java.lang.Integer defaultVersionId

The ID of the default provisioning template version.

description

java.lang.String description

The description of the provisioning template.

Constraints:
Length: 0 - 500
Pattern: [^\p{C}]*

enabled

java.lang.Boolean enabled

True to enable the provisioning template, otherwise false.

preProvisioningHook

ProvisioningHook preProvisioningHook

Updates the pre-provisioning hook template.

provisioningRoleArn

java.lang.String provisioningRoleArn

The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.

Constraints:
Length: 20 - 2048

removePreProvisioningHook

java.lang.Boolean removePreProvisioningHook

Removes pre-provisioning hook template.

templateName

java.lang.String templateName

The name of the provisioning template.

Constraints:
Length: 1 - 36
Pattern: ^[0-9A-Za-z_-]+$

Class com.amazonaws.services.iot.model.UpdateProvisioningTemplateResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.UpdateRoleAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

credentialDurationSeconds

java.lang.Integer credentialDurationSeconds

The number of seconds the credential will be valid.

This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.

Constraints:
Range: 900 - 43200

roleAlias

java.lang.String roleAlias

The role alias to update.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

roleArn

java.lang.String roleArn

The role ARN.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.iot.model.UpdateRoleAliasResult extends java.lang.Object implements Serializable

Serialized Fields

roleAlias

java.lang.String roleAlias

The role alias.

Constraints:
Length: 1 - 128
Pattern: [\w=,@-]+

roleAliasArn

java.lang.String roleAliasArn

The role alias ARN.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.iot.model.UpdateScheduledAuditRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dayOfMonth

java.lang.String dayOfMonth

The day of the month on which the scheduled audit takes place. This can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY. If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.

Constraints:
Pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$

dayOfWeek

java.lang.String dayOfWeek

The day of the week on which the scheduled audit takes place. This can be one of SUN, MON, TUE, WED, THU, FRI, or SAT . This field is required if the "frequency" parameter is set to WEEKLY or BIWEEKLY.

Constraints:
Allowed Values: SUN, MON, TUE, WED, THU, FRI, SAT

frequency

java.lang.String frequency

How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.

Constraints:
Allowed Values: DAILY, WEEKLY, BIWEEKLY, MONTHLY

scheduledAuditName

java.lang.String scheduledAuditName

The name of the scheduled audit. (Max. 128 chars)

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

targetCheckNames

java.util.List<java.lang.String> targetCheckNames

Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

Class com.amazonaws.services.iot.model.UpdateScheduledAuditResult extends java.lang.Object implements Serializable

Serialized Fields

scheduledAuditArn

java.lang.String scheduledAuditArn

The ARN of the scheduled audit.

Class com.amazonaws.services.iot.model.UpdateSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

additionalMetricsToRetain

java.util.List<java.lang.String> additionalMetricsToRetain

Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

additionalMetricsToRetainV2

java.util.List<MetricToRetain> additionalMetricsToRetainV2

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

alertTargets

java.util.Map<java.lang.String,AlertTarget> alertTargets

Where the alerts are sent. (Alerts are always sent to the console.)

behaviors

java.util.List<Behavior> behaviors

Specifies the behaviors that, when violated by a device (thing), cause an alert.

deleteAdditionalMetricsToRetain

java.lang.Boolean deleteAdditionalMetricsToRetain

If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

deleteAlertTargets

java.lang.Boolean deleteAlertTargets

If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

deleteBehaviors

java.lang.Boolean deleteBehaviors

If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

expectedVersion

java.lang.Long expectedVersion

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

securityProfileDescription

java.lang.String securityProfileDescription

A description of the security profile.

Constraints:
Length: - 1000
Pattern: [\p{Graph}\x20]*

securityProfileName

java.lang.String securityProfileName

The name of the security profile you want to update.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.UpdateSecurityProfileResult extends java.lang.Object implements Serializable

Serialized Fields

additionalMetricsToRetain

java.util.List<java.lang.String> additionalMetricsToRetain

Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's behaviors, but it is also retained for any metric specified here.

additionalMetricsToRetainV2

java.util.List<MetricToRetain> additionalMetricsToRetainV2

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

alertTargets

java.util.Map<java.lang.String,AlertTarget> alertTargets

Where the alerts are sent. (Alerts are always sent to the console.)

behaviors

java.util.List<Behavior> behaviors

Specifies the behaviors that, when violated by a device (thing), cause an alert.

creationDate

java.util.Date creationDate

The time the security profile was created.

lastModifiedDate

java.util.Date lastModifiedDate

The time the security profile was last modified.

securityProfileArn

java.lang.String securityProfileArn

The ARN of the security profile that was updated.

securityProfileDescription

java.lang.String securityProfileDescription

The description of the security profile.

Constraints:
Length: - 1000
Pattern: [\p{Graph}\x20]*

securityProfileName

java.lang.String securityProfileName

The name of the security profile that was updated.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

version

java.lang.Long version

The updated version of the security profile.

Class com.amazonaws.services.iot.model.UpdateStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

The description of the stream.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

files

java.util.List<StreamFile> files

The files associated with the stream.

roleArn

java.lang.String roleArn

An IAM role that allows the IoT service principal assumes to access your S3 files.

Constraints:
Length: 20 - 2048

streamId

java.lang.String streamId

The stream ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

Class com.amazonaws.services.iot.model.UpdateStreamResult extends java.lang.Object implements Serializable

Serialized Fields

description

java.lang.String description

A description of the stream.

Constraints:
Length: - 2028
Pattern: [^\p{C}]+

streamArn

java.lang.String streamArn

The stream ARN.

streamId

java.lang.String streamId

The stream ID.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+

streamVersion

java.lang.Integer streamVersion

The stream version.

Constraints:
Range: 0 - 65535

Class com.amazonaws.services.iot.model.UpdateThingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

expectedVersion

java.lang.Long expectedVersion

The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail.

thingGroupName

java.lang.String thingGroupName

The thing group to update.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingGroupProperties

ThingGroupProperties thingGroupProperties

The thing group properties.

Class com.amazonaws.services.iot.model.UpdateThingGroupResult extends java.lang.Object implements Serializable

Serialized Fields

version

java.lang.Long version

The version of the updated thing group.

Class com.amazonaws.services.iot.model.UpdateThingGroupsForThingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

overrideDynamicGroups

java.lang.Boolean overrideDynamicGroups

Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.

thingGroupsToAdd

java.util.List<java.lang.String> thingGroupsToAdd

The groups to which the thing will be added.

thingGroupsToRemove

java.util.List<java.lang.String> thingGroupsToRemove

The groups from which the thing will be removed.

thingName

java.lang.String thingName

The thing whose group memberships will be updated.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.UpdateThingGroupsForThingResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.UpdateThingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributePayload

AttributePayload attributePayload

A list of thing attributes, a JSON string containing name-value pairs. For example:

{\"attributes\":{\"name1\":\"value2\"}}

This data is used to add new attributes or update existing attributes.

expectedVersion

java.lang.Long expectedVersion

The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the UpdateThing request is rejected with a VersionConflictException.

removeThingType

java.lang.Boolean removeThingType

Remove a thing type association. If true, the association is removed.

thingName

java.lang.String thingName

The name of the thing to update.

You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingTypeName

java.lang.String thingTypeName

The name of the thing type.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iot.model.UpdateThingResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.UpdateTopicRuleDestinationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

java.lang.String arn

The ARN of the topic rule destination.

status

java.lang.String status

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Constraints:
Allowed Values: ENABLED, IN_PROGRESS, DISABLED, ERROR, DELETING

Class com.amazonaws.services.iot.model.UpdateTopicRuleDestinationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.iot.model.ValidateSecurityProfileBehaviorsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

behaviors

java.util.List<Behavior> behaviors

Specifies the behaviors that, when violated by a device (thing), cause an alert.

Class com.amazonaws.services.iot.model.ValidateSecurityProfileBehaviorsResult extends java.lang.Object implements Serializable

Serialized Fields

valid

java.lang.Boolean valid

True if the behaviors were valid.

validationErrors

java.util.List<ValidationError> validationErrors

The list of any errors found in the behaviors.

Class com.amazonaws.services.iot.model.ValidationError extends java.lang.Object implements Serializable

Serialized Fields

errorMessage

java.lang.String errorMessage

The description of an error found in the behaviors.

Constraints:
Length: - 2048

Class com.amazonaws.services.iot.model.VersionConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.VersionsLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.ViolationEvent extends java.lang.Object implements Serializable

Serialized Fields

behavior

Behavior behavior

The behavior that was violated.

metricValue

MetricValue metricValue

The value of the metric (the measurement).

securityProfileName

java.lang.String securityProfileName

The name of the security profile whose behavior was violated.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

thingName

java.lang.String thingName

The name of the thing responsible for the violation event.

Constraints:
Length: 1 - 128

verificationState

java.lang.String verificationState

The verification state of the violation (detect alarm).

Constraints:
Allowed Values: FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN

verificationStateDescription

java.lang.String verificationStateDescription

The description of the verification state of the violation.

Constraints:
Length: - 1000
Pattern: [^\p{Cntrl}]*

violationEventAdditionalInfo

ViolationEventAdditionalInfo violationEventAdditionalInfo

The details of a violation event.

violationEventTime

java.util.Date violationEventTime

The time the violation event occurred.

violationEventType

java.lang.String violationEventType

The type of violation event.

Constraints:
Allowed Values: in-alarm, alarm-cleared, alarm-invalidated

violationId

java.lang.String violationId

The ID of the violation event.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9\-]+

Class com.amazonaws.services.iot.model.ViolationEventAdditionalInfo extends java.lang.Object implements Serializable

Serialized Fields

confidenceLevel

java.lang.String confidenceLevel

The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.

Constraints:
Allowed Values: LOW, MEDIUM, HIGH

Class com.amazonaws.services.iot.model.ViolationEventOccurrenceRange extends java.lang.Object implements Serializable

Serialized Fields

endTime

java.util.Date endTime

The end date and time of a time period in which violation events occurred.

startTime

java.util.Date startTime

The start date and time of a time period in which violation events occurred.

Class com.amazonaws.services.iot.model.VpcDestinationConfiguration extends java.lang.Object implements Serializable

Serialized Fields

roleArn

java.lang.String roleArn

The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).

securityGroups

java.util.List<java.lang.String> securityGroups

The security groups of the VPC destination.

subnetIds

java.util.List<java.lang.String> subnetIds

The subnet IDs of the VPC destination.

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.iot.model.VpcDestinationProperties extends java.lang.Object implements Serializable

Serialized Fields

roleArn

java.lang.String roleArn

The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).

securityGroups

java.util.List<java.lang.String> securityGroups

The security groups of the VPC destination.

subnetIds

java.util.List<java.lang.String> subnetIds

The subnet IDs of the VPC destination.

vpcId

java.lang.String vpcId

The ID of the VPC.

Class com.amazonaws.services.iot.model.VpcDestinationSummary extends java.lang.Object implements Serializable

Serialized Fields

roleArn

java.lang.String roleArn

The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).

securityGroups

java.util.List<java.lang.String> securityGroups

The security groups of the VPC destination.

subnetIds

java.util.List<java.lang.String> subnetIds

The subnet IDs of the VPC destination.

vpcId

java.lang.String vpcId

The ID of the VPC.

Package com.amazonaws.services.iotdata.model

Class com.amazonaws.services.iotdata.model.ConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iotdata.model.DeleteThingShadowRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

shadowName

java.lang.String shadowName

The name of the shadow.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9:_-]+

thingName

java.lang.String thingName

The name of the thing.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iotdata.model.DeleteThingShadowResult extends java.lang.Object implements Serializable

Serialized Fields

payload

java.nio.ByteBuffer payload

The state information, in JSON format.

Class com.amazonaws.services.iotdata.model.GetRetainedMessageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

topic

java.lang.String topic

The topic name of the retained message to retrieve.

Class com.amazonaws.services.iotdata.model.GetRetainedMessageResult extends java.lang.Object implements Serializable

Serialized Fields

lastModifiedTime

java.lang.Long lastModifiedTime

The Epoch date and time, in milliseconds, when the retained message was stored by IoT.

payload

java.nio.ByteBuffer payload

The Base64-encoded message payload of the retained message body.

qos

java.lang.Integer qos

The quality of service (QoS) level used to publish the retained message.

Constraints:
Range: 0 - 1

topic

java.lang.String topic

The topic name to which the retained message was published.

Class com.amazonaws.services.iotdata.model.GetThingShadowRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

shadowName

java.lang.String shadowName

The name of the shadow.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9:_-]+

thingName

java.lang.String thingName

The name of the thing.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iotdata.model.GetThingShadowResult extends java.lang.Object implements Serializable

Serialized Fields

payload

java.nio.ByteBuffer payload

The state information, in JSON format.

Class com.amazonaws.services.iotdata.model.InternalFailureException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iotdata.model.InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iotdata.model.ListNamedShadowsForThingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to retrieve the next set of results.

pageSize

java.lang.Integer pageSize

The result page size.

Constraints:
Range: 1 - 100

thingName

java.lang.String thingName

The name of the thing.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iotdata.model.ListNamedShadowsForThingResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to get the next set of results, or null if there are no additional results.

results

java.util.List<java.lang.String> results

The list of shadows for the specified thing.

timestamp

java.lang.Long timestamp

The Epoch date and time the response was generated by IoT.

Class com.amazonaws.services.iotdata.model.ListRetainedMessagesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return at one time.

Constraints:
Range: 1 - 200

nextToken

java.lang.String nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Class com.amazonaws.services.iotdata.model.ListRetainedMessagesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token for the next set of results, or null if there are no additional results.

retainedTopics

java.util.List<RetainedMessageSummary> retainedTopics

A summary list the account's retained messages. The information returned doesn't include the message payloads of the retained messages.

Class com.amazonaws.services.iotdata.model.MethodNotAllowedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iotdata.model.PublishRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

payload

java.nio.ByteBuffer payload

The message body. MQTT accepts text, binary, and empty (null) message payloads.

Publishing an empty (null) payload with retain = true deletes the retained message identified by topic from IoT Core.

qos

java.lang.Integer qos

The Quality of Service (QoS) level.

Constraints:
Range: 0 - 1

retain

java.lang.Boolean retain

A Boolean value that determines whether to set the RETAIN flag when the message is published.

Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

Valid values: true | false

Default value: false

topic

java.lang.String topic

The name of the MQTT topic.

Class com.amazonaws.services.iotdata.model.RequestEntityTooLargeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iotdata.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iotdata.model.RetainedMessageSummary extends java.lang.Object implements Serializable

Serialized Fields

lastModifiedTime

java.lang.Long lastModifiedTime

The Epoch date and time, in milliseconds, when the retained message was stored by IoT.

payloadSize

java.lang.Long payloadSize

The size of the retained message's payload in bytes.

qos

java.lang.Integer qos

The quality of service (QoS) level used to publish the retained message.

Constraints:
Range: 0 - 1

topic

java.lang.String topic

The topic name to which the retained message was published.

Class com.amazonaws.services.iotdata.model.ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iotdata.model.ThrottlingException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iotdata.model.UnauthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iotdata.model.UnsupportedDocumentEncodingException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iotdata.model.UpdateThingShadowRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

payload

java.nio.ByteBuffer payload

The state information, in JSON format.

shadowName

java.lang.String shadowName

The name of the shadow.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9:_-]+

thingName

java.lang.String thingName

The name of the thing.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Class com.amazonaws.services.iotdata.model.UpdateThingShadowResult extends java.lang.Object implements Serializable

Serialized Fields

payload

java.nio.ByteBuffer payload

The state information, in JSON format.

Package com.amazonaws.services.kinesis.model

Class com.amazonaws.services.kinesis.model.AddTagsToStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamName

java.lang.String streamName

The name of the stream.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

tags

java.util.Map<java.lang.String,java.lang.String> tags

The set of key-value pairs to use to create the tags.

Class com.amazonaws.services.kinesis.model.CreateStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

shardCount

java.lang.Integer shardCount

The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.

DefaultShardLimit;

Constraints:
Range: 1 - 100000

streamName

java.lang.String streamName

A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates the stream. It is also scoped by AWS Region. That is, two streams in two different AWS accounts can have the same name. Two streams in the same AWS account but in two different Regions can also have the same name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.DecreaseStreamRetentionPeriodRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

retentionPeriodHours

java.lang.Integer retentionPeriodHours

The new retention period of the stream, in hours. Must be less than the current retention period.

Constraints:
Range: 1 - 168

streamName

java.lang.String streamName

The name of the stream to modify.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.DeleteStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamName

java.lang.String streamName

The name of the stream to delete.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.DescribeLimitsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.kinesis.model.DescribeLimitsResult extends java.lang.Object implements Serializable

Serialized Fields

openShardCount

java.lang.Integer openShardCount

The number of open shards.

Constraints:
Range: 0 - 1000000

shardLimit

java.lang.Integer shardLimit

The maximum number of shards.

Constraints:
Range: 0 - 1000000

Class com.amazonaws.services.kinesis.model.DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exclusiveStartShardId

java.lang.String exclusiveStartShardId

The shard ID of the shard to start with.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

limit

java.lang.Integer limit

The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

Constraints:
Range: 1 - 10000

streamName

java.lang.String streamName

The name of the stream to describe.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.DescribeStreamResult extends java.lang.Object implements Serializable

Serialized Fields

streamDescription

StreamDescription streamDescription

The current status of the stream, the stream Amazon Resource Name (ARN), an array of shard objects that comprise the stream, and whether there are more shards available.

Class com.amazonaws.services.kinesis.model.DescribeStreamSummaryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamName

java.lang.String streamName

The name of the stream to describe.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.DescribeStreamSummaryResult extends java.lang.Object implements Serializable

Serialized Fields

streamDescriptionSummary

StreamDescriptionSummary streamDescriptionSummary

A StreamDescriptionSummary containing information about the stream.

Class com.amazonaws.services.kinesis.model.DisableEnhancedMonitoringRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

shardLevelMetrics

java.util.List<java.lang.String> shardLevelMetrics

List of shard-level metrics to disable.

The following are the valid shard-level metrics. The value " ALL" disables every metric.

• IncomingBytes

• IncomingRecords

• OutgoingBytes

• OutgoingRecords

• WriteProvisionedThroughputExceeded

• ReadProvisionedThroughputExceeded

• IteratorAgeMilliseconds

• ALL

For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

streamName

java.lang.String streamName

The name of the Kinesis data stream for which to disable enhanced monitoring.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.DisableEnhancedMonitoringResult extends java.lang.Object implements Serializable

Serialized Fields

currentShardLevelMetrics

java.util.List<java.lang.String> currentShardLevelMetrics

Represents the current state of the metrics that are in the enhanced state before the operation.

desiredShardLevelMetrics

java.util.List<java.lang.String> desiredShardLevelMetrics

Represents the list of all the metrics that would be in the enhanced state after the operation.

streamName

java.lang.String streamName

The name of the Kinesis data stream.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.EnableEnhancedMonitoringRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

shardLevelMetrics

java.util.List<java.lang.String> shardLevelMetrics

List of shard-level metrics to enable.

The following are the valid shard-level metrics. The value " ALL" enables every metric.

• IncomingBytes

• IncomingRecords

• OutgoingBytes

• OutgoingRecords

• WriteProvisionedThroughputExceeded

• ReadProvisionedThroughputExceeded

• IteratorAgeMilliseconds

• ALL

For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

streamName

java.lang.String streamName

The name of the stream for which to enable enhanced monitoring.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.EnableEnhancedMonitoringResult extends java.lang.Object implements Serializable

Serialized Fields

currentShardLevelMetrics

java.util.List<java.lang.String> currentShardLevelMetrics

Represents the current state of the metrics that are in the enhanced state before the operation.

desiredShardLevelMetrics

java.util.List<java.lang.String> desiredShardLevelMetrics

Represents the list of all the metrics that would be in the enhanced state after the operation.

streamName

java.lang.String streamName

The name of the Kinesis data stream.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.EnhancedMetrics extends java.lang.Object implements Serializable

Serialized Fields

shardLevelMetrics

java.util.List<java.lang.String> shardLevelMetrics

List of shard-level metrics.

The following are the valid shard-level metrics. The value " ALL" enhances every metric.

• IncomingBytes

• IncomingRecords

• OutgoingBytes

• OutgoingRecords

• WriteProvisionedThroughputExceeded

• ReadProvisionedThroughputExceeded

• IteratorAgeMilliseconds

• ALL

For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

Class com.amazonaws.services.kinesis.model.ExpiredIteratorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesis.model.ExpiredNextTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesis.model.GetRecordsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

limit

java.lang.Integer limit

The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.

Constraints:
Range: 1 - 10000

shardIterator

java.lang.String shardIterator

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

Constraints:
Length: 1 - 512

Class com.amazonaws.services.kinesis.model.GetRecordsResult extends java.lang.Object implements Serializable

Serialized Fields

millisBehindLatest

java.lang.Long millisBehindLatest

The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.

Constraints:
Range: 0 -

nextShardIterator

java.lang.String nextShardIterator

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.

Constraints:
Length: 1 - 512

records

java.util.List<Record> records

The data records retrieved from the shard.

Class com.amazonaws.services.kinesis.model.GetShardIteratorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

shardId

java.lang.String shardId

The shard ID of the Kinesis Data Streams shard to get the iterator for.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

shardIteratorType

java.lang.String shardIteratorType

Determines how the shard iterator is used to start reading data records from the shard.

The following are the valid Amazon Kinesis shard iterator types:

• AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

• AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

• TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

• LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.

Constraints:
Allowed Values: AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP

startingSequenceNumber

java.lang.String startingSequenceNumber

The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

Constraints:
Pattern: 0|([1-9]\d{0,128})

streamName

java.lang.String streamName

The name of the Amazon Kinesis data stream.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

timestamp

java.util.Date timestamp

The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480 . If a record with this exact time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

Class com.amazonaws.services.kinesis.model.GetShardIteratorResult extends java.lang.Object implements Serializable

Serialized Fields

shardIterator

java.lang.String shardIterator

The position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard.

Constraints:
Length: 1 - 512

Class com.amazonaws.services.kinesis.model.HashKeyRange extends java.lang.Object implements Serializable

Serialized Fields

endingHashKey

java.lang.String endingHashKey

The ending hash key of the hash key range.

Constraints:
Pattern: 0|([1-9]\d{0,38})

startingHashKey

java.lang.String startingHashKey

The starting hash key of the hash key range.

Constraints:
Pattern: 0|([1-9]\d{0,38})

Class com.amazonaws.services.kinesis.model.IncreaseStreamRetentionPeriodRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

retentionPeriodHours

java.lang.Integer retentionPeriodHours

The new retention period of the stream, in hours. Must be more than the current retention period.

Constraints:
Range: 1 - 168

streamName

java.lang.String streamName

The name of the stream to modify.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.InvalidArgumentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesis.model.KMSAccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesis.model.KMSDisabledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesis.model.KMSInvalidStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesis.model.KMSNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesis.model.KMSOptInRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesis.model.KMSThrottlingException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesis.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesis.model.ListShardsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exclusiveStartShardId

java.lang.String exclusiveStartShardId

The ID of the shard to start the list with.

If you don't specify this parameter, the default behavior is for ListShards to list the shards starting with the first one in the stream.

You cannot specify this parameter if you specify NextToken.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

maxResults

java.lang.Integer maxResults

The maximum number of shards to return in a single call to ListShards. The minimum value you can specify for this parameter is 1, and the maximum is 1,000, which is also the default.

When the number of shards to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListShards to list the next set of shards.

Constraints:
Range: 1 - 10000

nextToken

java.lang.String nextToken

When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards.

Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.

You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of shards that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListShards operation.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.

Constraints:
Length: 1 - 1048576

streamCreationTimestamp

java.util.Date streamCreationTimestamp

Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.

You cannot specify this parameter if you specify the NextToken parameter.

streamName

java.lang.String streamName

The name of the data stream whose shards you want to list.

You cannot specify this parameter if you specify the NextToken parameter.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.ListShardsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards. For more information about the use of this pagination token when calling the ListShards operation, see ListShardsInput$NextToken.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.

Constraints:
Length: 1 - 1048576

shards

java.util.List<Shard> shards

An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.

Class com.amazonaws.services.kinesis.model.ListStreamsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exclusiveStartStreamName

java.lang.String exclusiveStartStreamName

The name of the stream to start the list with.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

limit

java.lang.Integer limit

The maximum number of streams to list.

Constraints:
Range: 1 - 10000

Class com.amazonaws.services.kinesis.model.ListStreamsResult extends java.lang.Object implements Serializable

Serialized Fields

hasMoreStreams

java.lang.Boolean hasMoreStreams

If set to true, there are more streams available to list.

streamNames

java.util.List<java.lang.String> streamNames

The names of the streams that are associated with the AWS account making the ListStreams request.

Class com.amazonaws.services.kinesis.model.ListTagsForStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exclusiveStartTagKey

java.lang.String exclusiveStartTagKey

The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.

Constraints:
Length: 1 - 128

limit

java.lang.Integer limit

The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response.

Constraints:
Range: 1 - 10

streamName

java.lang.String streamName

The name of the stream.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.ListTagsForStreamResult extends java.lang.Object implements Serializable

Serialized Fields

hasMoreTags

java.lang.Boolean hasMoreTags

If set to true, more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned.

tags

java.util.List<Tag> tags

A list of tags associated with StreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.

Class com.amazonaws.services.kinesis.model.MergeShardsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

adjacentShardToMerge

java.lang.String adjacentShardToMerge

The shard ID of the adjacent shard for the merge.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

shardToMerge

java.lang.String shardToMerge

The shard ID of the shard to combine with the adjacent shard for the merge.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

streamName

java.lang.String streamName

The name of the stream for the merge.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.ProvisionedThroughputExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesis.model.PutRecordRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

data

java.nio.ByteBuffer data

The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

Constraints:
Length: 0 - 1048576

explicitHashKey

java.lang.String explicitHashKey

The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.

Constraints:
Pattern: 0|([1-9]\d{0,38})

partitionKey

java.lang.String partitionKey

Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

Constraints:
Length: 1 - 256

sequenceNumberForOrdering

java.lang.String sequenceNumberForOrdering

Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in the result when putting record n-1). If this parameter is not set, records are coarsely ordered based on arrival time.

Constraints:
Pattern: 0|([1-9]\d{0,128})

streamName

java.lang.String streamName

The name of the stream to put the data record into.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.PutRecordResult extends java.lang.Object implements Serializable

Serialized Fields

encryptionType

java.lang.String encryptionType

The encryption type to use on the record. This parameter can be one of the following values:

• NONE: Do not encrypt the records in the stream.

• KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

Constraints:
Allowed Values: NONE, KMS

sequenceNumber

java.lang.String sequenceNumber

The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.

Constraints:
Pattern: 0|([1-9]\d{0,128})

shardId

java.lang.String shardId

The shard ID of the shard where the data record was placed.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.PutRecordsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

records

java.util.List<PutRecordsRequestEntry> records

The records associated with the request.

streamName

java.lang.String streamName

The stream name associated with the request.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.PutRecordsRequestEntry extends java.lang.Object implements Serializable

Serialized Fields

data

java.nio.ByteBuffer data

The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

Constraints:
Length: 0 - 1048576

explicitHashKey

java.lang.String explicitHashKey

The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.

Constraints:
Pattern: 0|([1-9]\d{0,38})

partitionKey

java.lang.String partitionKey

Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.kinesis.model.PutRecordsResult extends java.lang.Object implements Serializable

Serialized Fields

encryptionType

java.lang.String encryptionType

The encryption type used on the records. This parameter can be one of the following values:

• NONE: Do not encrypt the records.

• KMS: Use server-side encryption on the records using a customer-managed AWS KMS key.

Constraints:
Allowed Values: NONE, KMS

failedRecordCount

java.lang.Integer failedRecordCount

The number of unsuccessfully processed records in a PutRecords request.

Constraints:
Range: 1 - 100000

records

java.util.List<PutRecordsResultEntry> records

An array of successfully and unsuccessfully processed record results, correlated with the request by natural ordering. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to a stream includes ErrorCode and ErrorMessage in the result.

Class com.amazonaws.services.kinesis.model.PutRecordsResultEntry extends java.lang.Object implements Serializable

Serialized Fields

errorCode

java.lang.String errorCode

The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

errorMessage

java.lang.String errorMessage

The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure".

sequenceNumber

java.lang.String sequenceNumber

The sequence number for an individual record result.

Constraints:
Pattern: 0|([1-9]\d{0,128})

shardId

java.lang.String shardId

The shard ID for an individual record result.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.Record extends java.lang.Object implements Serializable

Serialized Fields

approximateArrivalTimestamp

java.util.Date approximateArrivalTimestamp

The approximate time that the record was inserted into the stream.

data

java.nio.ByteBuffer data

The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

Constraints:
Length: 0 - 1048576

encryptionType

java.lang.String encryptionType

The encryption type used on the record. This parameter can be one of the following values:

• NONE: Do not encrypt the records in the stream.

• KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

Constraints:
Allowed Values: NONE, KMS

partitionKey

java.lang.String partitionKey

Identifies which shard in the stream the data record is assigned to.

Constraints:
Length: 1 - 256

sequenceNumber

java.lang.String sequenceNumber

The unique identifier of the record within its shard.

Constraints:
Pattern: 0|([1-9]\d{0,128})

Class com.amazonaws.services.kinesis.model.RemoveTagsFromStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamName

java.lang.String streamName

The name of the stream.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

tagKeys

java.util.List<java.lang.String> tagKeys

A list of tag keys. Each corresponding tag is removed from the stream.

Class com.amazonaws.services.kinesis.model.ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesis.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesis.model.SequenceNumberRange extends java.lang.Object implements Serializable

Serialized Fields

endingSequenceNumber

java.lang.String endingSequenceNumber

The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null.

Constraints:
Pattern: 0|([1-9]\d{0,128})

startingSequenceNumber

java.lang.String startingSequenceNumber

The starting sequence number for the range.

Constraints:
Pattern: 0|([1-9]\d{0,128})

Class com.amazonaws.services.kinesis.model.Shard extends java.lang.Object implements Serializable

Serialized Fields

adjacentParentShardId

java.lang.String adjacentParentShardId

The shard ID of the shard adjacent to the shard's parent.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

hashKeyRange

HashKeyRange hashKeyRange

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

parentShardId

java.lang.String parentShardId

The shard ID of the shard's parent.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

sequenceNumberRange

SequenceNumberRange sequenceNumberRange

The range of possible sequence numbers for the shard.

shardId

java.lang.String shardId

The unique identifier of the shard within the stream.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.SplitShardRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

newStartingHashKey

java.lang.String newStartingHashKey

A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.

Constraints:
Pattern: 0|([1-9]\d{0,38})

shardToSplit

java.lang.String shardToSplit

The shard ID of the shard to split.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

streamName

java.lang.String streamName

The name of the stream for the shard split.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.StartStreamEncryptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

encryptionType

java.lang.String encryptionType

The encryption type to use. The only valid value is KMS.

Constraints:
Allowed Values: NONE, KMS

keyId

java.lang.String keyId

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

• Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

• Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

• Globally unique key ID example: 12345678-1234-1234-1234-123456789012

• Alias name example: alias/MyAliasName

• Master key owned by Kinesis Data Streams: alias/aws/kinesis

Constraints:
Length: 1 - 2048

streamName

java.lang.String streamName

The name of the stream for which to start encrypting records.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.StopStreamEncryptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

encryptionType

java.lang.String encryptionType

The encryption type. The only valid value is KMS.

Constraints:
Allowed Values: NONE, KMS

keyId

java.lang.String keyId

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

• Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

• Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

• Globally unique key ID example: 12345678-1234-1234-1234-123456789012

• Alias name example: alias/MyAliasName

• Master key owned by Kinesis Data Streams: alias/aws/kinesis

Constraints:
Length: 1 - 2048

streamName

java.lang.String streamName

The name of the stream on which to stop encrypting records.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesis.model.StreamDescription extends java.lang.Object implements Serializable

Serialized Fields

encryptionType

java.lang.String encryptionType

The server-side encryption type used on the stream. This parameter can be one of the following values:

• NONE: Do not encrypt the records in the stream.

• KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

Constraints:
Allowed Values: NONE, KMS

enhancedMonitoring

java.util.List<EnhancedMetrics> enhancedMonitoring

Represents the current enhanced monitoring settings of the stream.

hasMoreShards

java.lang.Boolean hasMoreShards

If set to true, more shards in the stream are available to describe.

keyId

java.lang.String keyId

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

• Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

• Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

• Globally unique key ID example: 12345678-1234-1234-1234-123456789012

• Alias name example: alias/MyAliasName

• Master key owned by Kinesis Data Streams: alias/aws/kinesis

Constraints:
Length: 1 - 2048

retentionPeriodHours

java.lang.Integer retentionPeriodHours

The current retention period, in hours.

Constraints:
Range: 1 - 168

shards

java.util.List<Shard> shards

The shards that comprise the stream.

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) for the stream being described.

streamCreationTimestamp

java.util.Date streamCreationTimestamp

The approximate time that the stream was created.

streamName

java.lang.String streamName

The name of the stream being described.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

streamStatus

java.lang.String streamStatus

The current status of the stream being described. The stream status is one of the following states:

• CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

• DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

• ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

• UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

Constraints:
Allowed Values: CREATING, DELETING, ACTIVE, UPDATING

Class com.amazonaws.services.kinesis.model.StreamDescriptionSummary extends java.lang.Object implements Serializable

Serialized Fields

encryptionType

java.lang.String encryptionType

The encryption type used. This value is one of the following:

• KMS

• NONE

Constraints:
Allowed Values: NONE, KMS

enhancedMonitoring

java.util.List<EnhancedMetrics> enhancedMonitoring

Represents the current enhanced monitoring settings of the stream.

keyId

java.lang.String keyId

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

• Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

• Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

• Globally unique key ID example: 12345678-1234-1234-1234-123456789012

• Alias name example: alias/MyAliasName

• Master key owned by Kinesis Data Streams: alias/aws/kinesis

Constraints:
Length: 1 - 2048

openShardCount

java.lang.Integer openShardCount

The number of open shards in the stream.

Constraints:
Range: 0 - 1000000

retentionPeriodHours

java.lang.Integer retentionPeriodHours

The current retention period, in hours.

Constraints:
Range: 1 - 100000

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) for the stream being described.

streamCreationTimestamp

java.util.Date streamCreationTimestamp

The approximate time that the stream was created.

streamName

java.lang.String streamName

The name of the stream being described.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

streamStatus

java.lang.String streamStatus

The current status of the stream being described. The stream status is one of the following states:

• CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

• DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

• ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

• UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

Constraints:
Allowed Values: CREATING, DELETING, ACTIVE, UPDATING

Class com.amazonaws.services.kinesis.model.Tag extends java.lang.Object implements Serializable

Serialized Fields

key

java.lang.String key

A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

Constraints:
Length: 1 - 128

value

java.lang.String value

An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

Constraints:
Length: 0 - 256

Class com.amazonaws.services.kinesis.model.UpdateShardCountRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

scalingType

java.lang.String scalingType

The scaling type. Uniform scaling creates shards of equal size.

Constraints:
Allowed Values: UNIFORM_SCALING

streamName

java.lang.String streamName

The name of the stream.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

targetShardCount

java.lang.Integer targetShardCount

The new number of shards.

Constraints:
Range: 1 - 100000

Class com.amazonaws.services.kinesis.model.UpdateShardCountResult extends java.lang.Object implements Serializable

Serialized Fields

currentShardCount

java.lang.Integer currentShardCount

The current number of shards.

Constraints:
Range: 1 - 100000

streamName

java.lang.String streamName

The name of the stream.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

targetShardCount

java.lang.Integer targetShardCount

The updated number of shards.

Constraints:
Range: 1 - 100000

Package com.amazonaws.services.kinesisfirehose.model

Class com.amazonaws.services.kinesisfirehose.model.InvalidArgumentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisfirehose.model.InvalidKMSResourceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

java.lang.String code

Class com.amazonaws.services.kinesisfirehose.model.PutRecordBatchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deliveryStreamName

java.lang.String deliveryStreamName

The name of the delivery stream.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+

records

java.util.List<Record> records

One or more records.

Class com.amazonaws.services.kinesisfirehose.model.PutRecordBatchResponseEntry extends java.lang.Object implements Serializable

Serialized Fields

errorCode

java.lang.String errorCode

The error code for an individual record result.

errorMessage

java.lang.String errorMessage

The error message for an individual record result.

recordId

java.lang.String recordId

The ID of the record.

Constraints:
Length: 1 -

Class com.amazonaws.services.kinesisfirehose.model.PutRecordBatchResult extends java.lang.Object implements Serializable

Serialized Fields

encrypted

java.lang.Boolean encrypted

Indicates whether server-side encryption (SSE) was enabled during this operation.

failedPutCount

java.lang.Integer failedPutCount

The number of records that might have failed processing. This number might be greater than 0 even if the PutRecordBatch call succeeds. Check FailedPutCount to determine whether there are records that you need to resend.

Constraints:
Range: 0 -

requestResponses

java.util.List<PutRecordBatchResponseEntry> requestResponses

The results array. For each record, the index of the response element is the same as the index used in the request array.

Class com.amazonaws.services.kinesisfirehose.model.Record extends java.lang.Object implements Serializable

Serialized Fields

data

java.nio.ByteBuffer data

The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KiB.

Constraints:
Length: 0 - 1024000

Class com.amazonaws.services.kinesisfirehose.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisfirehose.model.ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.kinesisvideo.model

Class com.amazonaws.services.kinesisvideo.model.AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideo.model.AccountChannelLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideo.model.AccountStreamLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideo.model.ChannelInfo extends java.lang.Object implements Serializable

Serialized Fields

channelARN

java.lang.String channelARN

The Amazon Resource Name (ARN) of the signaling channel.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

channelName

java.lang.String channelName

The name of the signaling channel.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

channelStatus

java.lang.String channelStatus

Current status of the signaling channel.

Constraints:
Allowed Values: CREATING, ACTIVE, UPDATING, DELETING

channelType

java.lang.String channelType

The type of the signaling channel.

Constraints:
Allowed Values: SINGLE_MASTER, FULL_MESH

creationTime

java.util.Date creationTime

The time at which the signaling channel was created.

singleMasterConfiguration

SingleMasterConfiguration singleMasterConfiguration

A structure that contains the configuration for the SINGLE_MASTER channel type.

version

java.lang.String version

The current version of the signaling channel.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9]+

Class com.amazonaws.services.kinesisvideo.model.ChannelNameCondition extends java.lang.Object implements Serializable

Serialized Fields

comparisonOperator

java.lang.String comparisonOperator

A comparison operator. Currently, you can only specify the BEGINS_WITH operator, which finds signaling channels whose names begin with a given prefix.

Constraints:
Allowed Values: BEGINS_WITH

comparisonValue

java.lang.String comparisonValue

A value to compare.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideo.model.ClientLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideo.model.CreateSignalingChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

channelName

java.lang.String channelName

A name for the signaling channel that you are creating. It must be unique for each Amazon Web Services account and Amazon Web Services Region.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

channelType

java.lang.String channelType

A type of the signaling channel that you are creating. Currently, SINGLE_MASTER is the only supported channel type.

Constraints:
Allowed Values: SINGLE_MASTER, FULL_MESH

singleMasterConfiguration

SingleMasterConfiguration singleMasterConfiguration

A structure containing the configuration for the SINGLE_MASTER channel type.

tags

java.util.List<Tag> tags

A set of tags (key-value pairs) that you want to associate with this channel.

Class com.amazonaws.services.kinesisvideo.model.CreateSignalingChannelResult extends java.lang.Object implements Serializable

Serialized Fields

channelARN

java.lang.String channelARN

The Amazon Resource Name (ARN) of the created channel.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

Class com.amazonaws.services.kinesisvideo.model.CreateStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dataRetentionInHours

java.lang.Integer dataRetentionInHours

The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

Constraints:
Range: 0 -

deviceName

java.lang.String deviceName

The name of the device that is writing to the stream.

In the current implementation, Kinesis Video Streams does not use this name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

kmsKeyId

java.lang.String kmsKeyId

The ID of the Key Management Service (KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

If no key ID is specified, the default, Kinesis Video-managed key ( aws/kinesisvideo) is used.

For more information, see DescribeKey.

Constraints:
Length: 1 - 2048
Pattern: .+

mediaType

java.lang.String mediaType

The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.

Example valid values include "video/h264" and "video/h264,audio/aac".

This parameter is optional; the default value is null (or empty in JSON).

Constraints:
Length: 1 - 128
Pattern: [\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*

streamName

java.lang.String streamName

A name for the stream that you are creating.

The stream name is an identifier for the stream, and must be unique for each account and region.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

tags

java.util.Map<java.lang.String,java.lang.String> tags

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

Class com.amazonaws.services.kinesisvideo.model.CreateStreamResult extends java.lang.Object implements Serializable

Serialized Fields

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the stream.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

Class com.amazonaws.services.kinesisvideo.model.DeleteSignalingChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

channelARN

java.lang.String channelARN

The Amazon Resource Name (ARN) of the signaling channel that you want to delete.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

currentVersion

java.lang.String currentVersion

The current version of the signaling channel that you want to delete. You can obtain the current version by invoking the DescribeSignalingChannel or ListSignalingChannels API operations.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9]+

Class com.amazonaws.services.kinesisvideo.model.DeleteSignalingChannelResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.kinesisvideo.model.DeleteStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

currentVersion

java.lang.String currentVersion

Optional: The version of the stream that you want to delete.

Specify the version as a safeguard to ensure that your are deleting the correct stream. To get the stream version, use the DescribeStream API.

If not specified, only the CreationTime is checked before deleting the stream.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9]+

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the stream that you want to delete.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

Class com.amazonaws.services.kinesisvideo.model.DeleteStreamResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.kinesisvideo.model.DescribeImageGenerationConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the Kinesis video stream from which to retrieve the image generation configuration. You must specify either the StreamName or the StreamARN.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream from which to retrieve the image generation configuration. You must specify either the StreamName or the StreamARN.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideo.model.DescribeImageGenerationConfigurationResult extends java.lang.Object implements Serializable

Serialized Fields

imageGenerationConfiguration

ImageGenerationConfiguration imageGenerationConfiguration

The structure that contains the information required for the Kinesis video stream (KVS) images delivery. If this structure is null, the configuration will be deleted from the stream.

Class com.amazonaws.services.kinesisvideo.model.DescribeNotificationConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to retrieve the notification configuration. You must specify either the StreamName or the StreamARN.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream from which to retrieve the notification configuration. You must specify either the StreamName or the StreamARN.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideo.model.DescribeNotificationConfigurationResult extends java.lang.Object implements Serializable

Serialized Fields

notificationConfiguration

NotificationConfiguration notificationConfiguration

The structure that contains the information required for notifications. If the structure is null, the configuration will be deleted from the stream.

Class com.amazonaws.services.kinesisvideo.model.DescribeSignalingChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

channelARN

java.lang.String channelARN

The ARN of the signaling channel that you want to describe.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

channelName

java.lang.String channelName

The name of the signaling channel that you want to describe.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideo.model.DescribeSignalingChannelResult extends java.lang.Object implements Serializable

Serialized Fields

channelInfo

ChannelInfo channelInfo

A structure that encapsulates the specified signaling channel's metadata and properties.

Class com.amazonaws.services.kinesisvideo.model.DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the stream.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideo.model.DescribeStreamResult extends java.lang.Object implements Serializable

Serialized Fields

streamInfo

StreamInfo streamInfo

An object that describes the stream.

Class com.amazonaws.services.kinesisvideo.model.DeviceStreamLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideo.model.GetDataEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aPIName

java.lang.String aPIName

The name of the API action for which to get an endpoint.

Constraints:
Allowed Values: PUT_MEDIA, GET_MEDIA, LIST_FRAGMENTS, GET_MEDIA_FOR_FRAGMENT_LIST, GET_HLS_STREAMING_SESSION_URL, GET_DASH_STREAMING_SESSION_URL, GET_CLIP, GET_IMAGES

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamName in the request.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamARN in the request.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideo.model.GetDataEndpointResult extends java.lang.Object implements Serializable

Serialized Fields

dataEndpoint

java.lang.String dataEndpoint

The endpoint value. To read data from the stream or to write data to it, specify this endpoint in your application.

Class com.amazonaws.services.kinesisvideo.model.GetSignalingChannelEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

channelARN

java.lang.String channelARN

The Amazon Resource Name (ARN) of the signalling channel for which you want to get an endpoint.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

singleMasterChannelEndpointConfiguration

SingleMasterChannelEndpointConfiguration singleMasterChannelEndpointConfiguration

A structure containing the endpoint configuration for the SINGLE_MASTER channel type.

Class com.amazonaws.services.kinesisvideo.model.GetSignalingChannelEndpointResult extends java.lang.Object implements Serializable

Serialized Fields

resourceEndpointList

java.util.List<ResourceEndpointListItem> resourceEndpointList

A list of endpoints for the specified signaling channel.

Class com.amazonaws.services.kinesisvideo.model.ImageGenerationConfiguration extends java.lang.Object implements Serializable

Serialized Fields

destinationConfig

ImageGenerationDestinationConfig destinationConfig

The structure that contains the information required to deliver images to a customer.

format

java.lang.String format

The accepted image format.

Constraints:
Allowed Values: JPEG, PNG

formatConfig

java.util.Map<java.lang.String,java.lang.String> formatConfig

The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

heightPixels

java.lang.Integer heightPixels

The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

Constraints:
Range: 1 - 2160

imageSelectorType

java.lang.String imageSelectorType

The origin of the Server or Producer timestamps to use to generate the images.

Constraints:
Allowed Values: SERVER_TIMESTAMP, PRODUCER_TIMESTAMP

samplingInterval

java.lang.Integer samplingInterval

The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 33 ms, because a camera that generates content at 30 FPS would create a frame every 33.3 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

Constraints:
Range: 3000 - 20000

status

java.lang.String status

Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

Constraints:
Allowed Values: ENABLED, DISABLED

widthPixels

java.lang.Integer widthPixels

The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.

Constraints:
Range: 1 - 3840

Class com.amazonaws.services.kinesisvideo.model.ImageGenerationDestinationConfig extends java.lang.Object implements Serializable

Serialized Fields

destinationRegion

java.lang.String destinationRegion

The AWS Region of the S3 bucket where images will be delivered. This DestinationRegion must match the Region where the stream is located.

Constraints:
Length: 9 - 14
Pattern: ^[a-z]+(-[a-z]+)?-[a-z]+-[0-9]$

uri

java.lang.String uri

The Uniform Resource Idenifier (URI) that identifies where the images will be delivered.

Constraints:
Length: 1 - 255
Pattern: ^[a-zA-Z_0-9]+:(//)?([^/]+)/?([^*]*)$

Class com.amazonaws.services.kinesisvideo.model.InvalidArgumentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideo.model.InvalidDeviceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideo.model.InvalidResourceFormatException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideo.model.ListSignalingChannelsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

channelNameCondition

ChannelNameCondition channelNameCondition

Optional: Returns only the channels that satisfy a specific condition.

maxResults

java.lang.Integer maxResults

The maximum number of channels to return in the response. The default is 500.

Constraints:
Range: 1 - 10000

nextToken

java.lang.String nextToken

If you specify this parameter, when the result of a ListSignalingChannels operation is truncated, the call returns the NextToken in the response. To get another batch of channels, provide this token in your next request.

Constraints:
Length: 0 - 512
Pattern: [a-zA-Z0-9+/=]*

Class com.amazonaws.services.kinesisvideo.model.ListSignalingChannelsResult extends java.lang.Object implements Serializable

Serialized Fields

channelInfoList

java.util.List<ChannelInfo> channelInfoList

An array of ChannelInfo objects.

nextToken

java.lang.String nextToken

If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request.

Constraints:
Length: 0 - 512
Pattern: [a-zA-Z0-9+/=]*

Class com.amazonaws.services.kinesisvideo.model.ListStreamsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of streams to return in the response. The default is 10,000.

Constraints:
Range: 1 - 10000

nextToken

java.lang.String nextToken

If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.

Constraints:
Length: 0 - 512
Pattern: [a-zA-Z0-9+/=]*

streamNameCondition

StreamNameCondition streamNameCondition

Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

Class com.amazonaws.services.kinesisvideo.model.ListStreamsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request.

Constraints:
Length: 0 - 512
Pattern: [a-zA-Z0-9+/=]*

streamInfoList

java.util.List<StreamInfo> streamInfoList

An array of StreamInfo objects.

Class com.amazonaws.services.kinesisvideo.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If you specify this parameter and the result of a ListTagsForResource call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags.

Constraints:
Length: 0 - 512
Pattern: [a-zA-Z0-9+/=]*

resourceARN

java.lang.String resourceARN

The Amazon Resource Name (ARN) of the signaling channel for which you want to list tags.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

Class com.amazonaws.services.kinesisvideo.model.ListTagsForResourceResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If you specify this parameter and the result of a ListTagsForResource call is truncated, the response includes a token that you can use in the next request to fetch the next set of tags.

Constraints:
Length: 0 - 512
Pattern: [a-zA-Z0-9+/=]*

tags

java.util.Map<java.lang.String,java.lang.String> tags

A map of tag keys and values associated with the specified signaling channel.

Class com.amazonaws.services.kinesisvideo.model.ListTagsForStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If you specify this parameter and the result of a ListTagsForStream call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags.

Constraints:
Length: 0 - 512
Pattern: [a-zA-Z0-9+/=]*

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the stream that you want to list tags for.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream that you want to list tags for.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideo.model.ListTagsForStreamResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If you specify this parameter and the result of a ListTags call is truncated, the response includes a token that you can use in the next request to fetch the next set of tags.

Constraints:
Length: 0 - 512
Pattern: [a-zA-Z0-9+/=]*

tags

java.util.Map<java.lang.String,java.lang.String> tags

A map of tag keys and values associated with the specified stream.

Class com.amazonaws.services.kinesisvideo.model.NoDataRetentionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideo.model.NotAuthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideo.model.NotificationConfiguration extends java.lang.Object implements Serializable

Serialized Fields

destinationConfig

NotificationDestinationConfig destinationConfig

The destination information required to deliver a notification to a customer.

status

java.lang.String status

Indicates if a notification configuration is enabled or disabled.

Constraints:
Allowed Values: ENABLED, DISABLED

Class com.amazonaws.services.kinesisvideo.model.NotificationDestinationConfig extends java.lang.Object implements Serializable

Serialized Fields

uri

java.lang.String uri

The Uniform Resource Idenifier (URI) that identifies where the images will be delivered.

Constraints:
Length: 1 - 255
Pattern: ^[a-zA-Z_0-9]+:(//)?([^/]+)/?([^*]*)$

Class com.amazonaws.services.kinesisvideo.model.ResourceEndpointListItem extends java.lang.Object implements Serializable

Serialized Fields

protocol

java.lang.String protocol

The protocol of the signaling channel returned by the GetSignalingChannelEndpoint API.

Constraints:
Allowed Values: WSS, HTTPS

resourceEndpoint

java.lang.String resourceEndpoint

The endpoint of the signaling channel returned by the GetSignalingChannelEndpoint API.

Class com.amazonaws.services.kinesisvideo.model.ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideo.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideo.model.SingleMasterChannelEndpointConfiguration extends java.lang.Object implements Serializable

Serialized Fields

protocols

java.util.List<java.lang.String> protocols

This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel. If WSS is specified, this API returns a websocket endpoint. If HTTPS is specified, this API returns an HTTPS endpoint.

role

java.lang.String role

This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel. If MASTER is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. If VIEWER is specified, this API returns an endpoint that a client can use only to send offers to another MASTER client on this signaling channel.

Constraints:
Allowed Values: MASTER, VIEWER

Class com.amazonaws.services.kinesisvideo.model.SingleMasterConfiguration extends java.lang.Object implements Serializable

Serialized Fields

messageTtlSeconds

java.lang.Integer messageTtlSeconds

The period of time a signaling channel retains undelivered messages before they are discarded.

Constraints:
Range: 5 - 120

Class com.amazonaws.services.kinesisvideo.model.StreamInfo extends java.lang.Object implements Serializable

Serialized Fields

creationTime

java.util.Date creationTime

A time stamp that indicates when the stream was created.

dataRetentionInHours

java.lang.Integer dataRetentionInHours

How long the stream retains data, in hours.

Constraints:
Range: 0 -

deviceName

java.lang.String deviceName

The name of the device that is associated with the stream.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

kmsKeyId

java.lang.String kmsKeyId

The ID of the Key Management Service (KMS) key that Kinesis Video Streams uses to encrypt data on the stream.

Constraints:
Length: 1 - 2048
Pattern: .+

mediaType

java.lang.String mediaType

The MediaType of the stream.

Constraints:
Length: 1 - 128
Pattern: [\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*

status

java.lang.String status

The status of the stream.

Constraints:
Allowed Values: CREATING, ACTIVE, UPDATING, DELETING

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the stream.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

version

java.lang.String version

The version of the stream.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9]+

Class com.amazonaws.services.kinesisvideo.model.StreamNameCondition extends java.lang.Object implements Serializable

Serialized Fields

comparisonOperator

java.lang.String comparisonOperator

A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix.

Constraints:
Allowed Values: BEGINS_WITH

comparisonValue

java.lang.String comparisonValue

A value to compare.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideo.model.Tag extends java.lang.Object implements Serializable

Serialized Fields

key

java.lang.String key

The key of the tag that is associated with the specified signaling channel.

Constraints:
Length: 1 - 128
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

value

java.lang.String value

The value of the tag that is associated with the specified signaling channel.

Constraints:
Length: 0 - 256
Pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]*

Class com.amazonaws.services.kinesisvideo.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceARN

java.lang.String resourceARN

The Amazon Resource Name (ARN) of the signaling channel to which you want to add tags.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

tags

java.util.List<Tag> tags

A list of tags to associate with the specified signaling channel. Each tag is a key-value pair.

Class com.amazonaws.services.kinesisvideo.model.TagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.kinesisvideo.model.TagsPerResourceExceededLimitException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideo.model.TagStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream that you want to add the tag or tags to.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

tags

java.util.Map<java.lang.String,java.lang.String> tags

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

Class com.amazonaws.services.kinesisvideo.model.TagStreamResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.kinesisvideo.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceARN

java.lang.String resourceARN

The Amazon Resource Name (ARN) of the signaling channel from which you want to remove tags.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

tagKeyList

java.util.List<java.lang.String> tagKeyList

A list of the keys of the tags that you want to remove.

Class com.amazonaws.services.kinesisvideo.model.UntagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.kinesisvideo.model.UntagStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the stream that you want to remove tags from.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream that you want to remove tags from.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

tagKeyList

java.util.List<java.lang.String> tagKeyList

A list of the keys of the tags that you want to remove.

Class com.amazonaws.services.kinesisvideo.model.UntagStreamResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.kinesisvideo.model.UpdateDataRetentionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

currentVersion

java.lang.String currentVersion

The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9]+

dataRetentionChangeInHours

java.lang.Integer dataRetentionChangeInHours

The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years).

Constraints:
Range: 1 -

operation

java.lang.String operation

Indicates whether you want to increase or decrease the retention period.

Constraints:
Allowed Values: INCREASE_DATA_RETENTION, DECREASE_DATA_RETENTION

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the stream whose retention period you want to change.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream whose retention period you want to change.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideo.model.UpdateDataRetentionResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.kinesisvideo.model.UpdateImageGenerationConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

imageGenerationConfiguration

ImageGenerationConfiguration imageGenerationConfiguration

The structure that contains the information required for the KVS images delivery. If the structure is null, the configuration will be deleted from the stream.

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to update the image generation configuration. You must specify either the StreamName or the StreamARN.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream from which to update the image generation configuration. You must specify either the StreamName or the StreamARN.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideo.model.UpdateImageGenerationConfigurationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.kinesisvideo.model.UpdateNotificationConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

notificationConfiguration

NotificationConfiguration notificationConfiguration

The structure containing the information required for notifications. If the structure is null, the configuration will be deleted from the stream.

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to update the notification configuration. You must specify either the StreamName or the StreamARN.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream from which to update the notification configuration. You must specify either the StreamName or the StreamARN.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideo.model.UpdateNotificationConfigurationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.kinesisvideo.model.UpdateSignalingChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

channelARN

java.lang.String channelARN

The Amazon Resource Name (ARN) of the signaling channel that you want to update.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

currentVersion

java.lang.String currentVersion

The current version of the signaling channel that you want to update.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9]+

singleMasterConfiguration

SingleMasterConfiguration singleMasterConfiguration

The structure containing the configuration for the SINGLE_MASTER type of the signaling channel that you want to update.

Class com.amazonaws.services.kinesisvideo.model.UpdateSignalingChannelResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.kinesisvideo.model.UpdateStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

currentVersion

java.lang.String currentVersion

The version of the stream whose metadata you want to update.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9]+

deviceName

java.lang.String deviceName

The name of the device that is writing to the stream.

In the current implementation, Kinesis Video Streams does not use this name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

mediaType

java.lang.String mediaType

The stream's media type. Use MediaType to specify the type of content that the stream contains to the consumers of the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements.

To play video on the console, you must specify the correct video type. For example, if the video in the stream is H.264, specify video/h264 as the MediaType.

Constraints:
Length: 1 - 128
Pattern: [\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*

streamARN

java.lang.String streamARN

The ARN of the stream whose metadata you want to update.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream whose metadata you want to update.

The stream name is an identifier for the stream, and must be unique for each account and region.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideo.model.UpdateStreamResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.kinesisvideo.model.VersionMismatchException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.kinesisvideoarchivedmedia.model

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.ClientLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.ClipFragmentSelector extends java.lang.Object implements Serializable

Serialized Fields

fragmentSelectorType

java.lang.String fragmentSelectorType

The origin of the timestamps to use (Server or Producer).

Constraints:
Allowed Values: PRODUCER_TIMESTAMP, SERVER_TIMESTAMP

timestampRange

ClipTimestampRange timestampRange

The range of timestamps to return.

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.ClipTimestampRange extends java.lang.Object implements Serializable

Serialized Fields

endTimestamp

java.util.Date endTimestamp

The end of the timestamp range for the requested media.

This value must be within 24 hours of the specified StartTimestamp, and it must be later than the StartTimestamp value. If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the past.

This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment. Fragments that start before the EndTimestamp value and continue past it are included in the session.

startTimestamp

java.util.Date startTimestamp

The starting timestamp in the range of timestamps for which to return fragments.

Only fragments that start exactly at or after StartTimestamp are included in the session. Fragments that start before StartTimestamp and continue past it aren't included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head.

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.DASHFragmentSelector extends java.lang.Object implements Serializable

Serialized Fields

fragmentSelectorType

java.lang.String fragmentSelectorType

The source of the timestamps for the requested media.

When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetDASHStreamingSessionURLInput$PlaybackMode is ON_DEMAND or LIVE_REPLAY, the first fragment ingested with a producer timestamp within the specified FragmentSelector$TimestampRange is included in the media playlist. In addition, the fragments with producer timestamps within the TimestampRange ingested immediately following the first fragment (up to the GetDASHStreamingSessionURLInput$MaxManifestFragmentResults value) are included.

Fragments that have duplicate producer timestamps are deduplicated. This means that if producers are producing a stream of fragments with producer timestamps that are approximately equal to the true clock time, the MPEG-DASH manifest will contain all of the fragments within the requested timestamp range. If some fragments are ingested within the same time range and very different points in time, only the oldest ingested collection of fragments are returned.

When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetDASHStreamingSessionURLInput$PlaybackMode is LIVE, the producer timestamps are used in the MP4 fragments and for deduplication. But the most recently ingested fragments based on server timestamps are included in the MPEG-DASH manifest. This means that even if fragments ingested in the past have producer timestamps with values now, they are not included in the HLS media playlist.

The default is SERVER_TIMESTAMP.

Constraints:
Allowed Values: PRODUCER_TIMESTAMP, SERVER_TIMESTAMP

timestampRange

DASHTimestampRange timestampRange

The start and end of the timestamp range for the requested media.

This value should not be present if PlaybackType is LIVE.

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.DASHTimestampRange extends java.lang.Object implements Serializable

Serialized Fields

endTimestamp

java.util.Date endTimestamp

The end of the timestamp range for the requested media. This value must be within 24 hours of the specified StartTimestamp, and it must be later than the StartTimestamp value.

If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the past.

The EndTimestamp value is required for ON_DEMAND mode, but optional for LIVE_REPLAY mode. If the EndTimestamp is not set for LIVE_REPLAY mode then the session will continue to include newly ingested fragments until the session expires.

This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment. Fragments that start before the EndTimestamp value and continue past it are included in the session.

startTimestamp

java.util.Date startTimestamp

The start of the timestamp range for the requested media.

If the DASHTimestampRange value is specified, the StartTimestamp value is required.

Only fragments that start exactly at or after StartTimestamp are included in the session. Fragments that start before StartTimestamp and continue past it aren't included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head.

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.Fragment extends java.lang.Object implements Serializable

Serialized Fields

fragmentLengthInMilliseconds

java.lang.Long fragmentLengthInMilliseconds

The playback duration or other time value associated with the fragment.

fragmentNumber

java.lang.String fragmentNumber

The unique identifier of the fragment. This value monotonically increases based on the ingestion order.

Constraints:
Length: 1 - 128
Pattern: ^[0-9]+$

fragmentSizeInBytes

java.lang.Long fragmentSizeInBytes

The total fragment size, including information about the fragment and contained media data.

producerTimestamp

java.util.Date producerTimestamp

The timestamp from the producer corresponding to the fragment.

serverTimestamp

java.util.Date serverTimestamp

The timestamp from the AWS server corresponding to the fragment.

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.FragmentSelector extends java.lang.Object implements Serializable

Serialized Fields

fragmentSelectorType

java.lang.String fragmentSelectorType

The origin of the timestamps to use (Server or Producer).

Constraints:
Allowed Values: PRODUCER_TIMESTAMP, SERVER_TIMESTAMP

timestampRange

TimestampRange timestampRange

The range of timestamps to return.

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.GetClipRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clipFragmentSelector

ClipFragmentSelector clipFragmentSelector

The time range of the requested clip and the source of the timestamps.

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the stream for which to retrieve the media clip.

You must specify either the StreamName or the StreamARN.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream for which to retrieve the media clip.

You must specify either the StreamName or the StreamARN.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.GetClipResult extends java.lang.Object implements Serializable

Serialized Fields

contentType

java.lang.String contentType

The content type of the media in the requested clip.

Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_\.\-]+$

payload

java.io.InputStream payload

Traditional MP4 file that contains the media clip from the specified video stream. The output will contain the first 100 MB or the first 200 fragments from the specified start timestamp. For more information, see Kinesis Video Streams Limits.

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.GetDASHStreamingSessionURLRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dASHFragmentSelector

DASHFragmentSelector dASHFragmentSelector

The time range of the requested fragment and the source of the timestamps.

This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This parameter is optional if PlaybackMode is LIVE. If PlaybackMode is LIVE, the FragmentSelectorType can be set, but the TimestampRange should not be set. If PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and TimestampRange must be set.

displayFragmentNumber

java.lang.String displayFragmentNumber

Fragments are identified in the manifest file based on their sequence number in the session. If DisplayFragmentNumber is set to ALWAYS, the Kinesis Video Streams fragment number is added to each S element in the manifest file with the attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with other APIs (e.g. GetMedia and GetMediaForFragmentList). A custom MPEG-DASH media player is necessary to leverage these this custom attribute.

The default value is NEVER.

Constraints:
Allowed Values: ALWAYS, NEVER

displayFragmentTimestamp

java.lang.String displayFragmentTimestamp

Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file can be derived using attributes in the manifest itself. However, typically, MPEG-DASH compatible media players do not properly handle gaps in the media timeline. Kinesis Video Streams adjusts the media timeline in the manifest file to enable playback of media with discontinuities. Therefore, the wall-clock time derived from the manifest file may be inaccurate. If DisplayFragmentTimestamp is set to ALWAYS, the accurate fragment timestamp is added to each S element in the manifest file with the attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this custom attribute.

The default value is NEVER. When DASHFragmentSelector is SERVER_TIMESTAMP, the timestamps will be the server start timestamps. Similarly, when DASHFragmentSelector is PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.

Constraints:
Allowed Values: ALWAYS, NEVER

expires

java.lang.Integer expires

The time in seconds until the requested session expires. This value can be between 300 (5 minutes) and 43200 (12 hours).

When a session expires, no new calls to GetDashManifest, GetMP4InitFragment, or GetMP4MediaFragment can be made for that session.

The default is 300 (5 minutes).

Constraints:
Range: 300 - 43200

maxManifestFragmentResults

java.lang.Long maxManifestFragmentResults

The maximum number of fragments that are returned in the MPEG-DASH manifest.

When the PlaybackMode is LIVE, the most recent fragments are returned up to this value. When the PlaybackMode is ON_DEMAND, the oldest fragments are returned, up to this maximum number.

When there are a higher number of fragments available in a live MPEG-DASH manifest, video players often buffer content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the likelihood that rebuffering will occur during playback. We recommend that a live MPEG-DASH manifest have a minimum of 3 fragments and a maximum of 10 fragments.

The default is 5 fragments if PlaybackMode is LIVE or LIVE_REPLAY, and 1,000 if PlaybackMode is ON_DEMAND.

The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on streams with 1-second fragments, and more than 2 1/2 hours of video on streams with 10-second fragments.

Constraints:
Range: 1 - 5000

playbackMode

java.lang.String playbackMode

Whether to retrieve live, live replay, or archived, on-demand data.

Features of the three types of sessions include the following:

• LIVE : For sessions of this type, the MPEG-DASH manifest is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new manifest on a one-second interval. When this type of session is played in a media player, the user interface typically displays a "live" notification, with no scrubber control for choosing the position in the playback window to display.

  In LIVE mode, the newest available fragments are included in an MPEG-DASH manifest, even if there is a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt or cause a jump in playback. In this mode, fragments are not added to the MPEG-DASH manifest if they are older than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment is added to the manifest, the older fragment is not added, and the gap is not filled.

• LIVE_REPLAY : For sessions of this type, the MPEG-DASH manifest is updated similarly to how it is updated for LIVE mode except that it starts by including fragments from a given start time. Instead of fragments being added as they are ingested, fragments are added as the duration of the next fragment elapses. For example, if the fragments in the session are two seconds long, then a new fragment is added to the manifest every two seconds. This mode is useful to be able to start playback from when an event is detected and continue live streaming media that has not yet been ingested as of the time of the session creation. This mode is also useful to stream previously archived media without being limited by the 1,000 fragment limit in the ON_DEMAND mode.

• ON_DEMAND : For sessions of this type, the MPEG-DASH manifest contains all the fragments for the session, up to the number that is specified in MaxManifestFragmentResults. The manifest must be retrieved only once for each session. When this type of session is played in a media player, the user interface typically displays a scrubber control for choosing the position in the playback window to display.

In all playback modes, if FragmentSelectorType is PRODUCER_TIMESTAMP, and if there are multiple fragments with the same start timestamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the MPEG-DASH manifest. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media player.

The default is LIVE.

Constraints:
Allowed Values: LIVE, LIVE_REPLAY, ON_DEMAND

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.GetDASHStreamingSessionURLResult extends java.lang.Object implements Serializable

Serialized Fields

dASHStreamingSessionURL

java.lang.String dASHStreamingSessionURL

The URL (containing the session token) that a media player can use to retrieve the MPEG-DASH manifest.

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.GetHLSStreamingSessionURLRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

containerFormat

java.lang.String containerFormat

Specifies which format should be used for packaging the media. Specifying the FRAGMENTED_MP4 container format packages the media into MP4 fragments (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging overhead. The other container format option is MPEG_TS. HLS has supported MPEG TS chunks since it was released and is sometimes the only supported packaging on older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4.

The default is FRAGMENTED_MP4.

Constraints:
Allowed Values: FRAGMENTED_MP4, MPEG_TS

discontinuityMode

java.lang.String discontinuityMode

Specifies when flags marking discontinuities between fragments are added to the media playlists.

Media players typically build a timeline of media content to play, based on the timestamps of each fragment. This means that if there is any overlap or gap between fragments (as is typical if HLSFragmentSelector is set to SERVER_TIMESTAMP), the media player timeline will also have small gaps between fragments in some places, and will overwrite frames in other places. Gaps in the media player timeline can cause playback to stall and overlaps can cause playback to be jittery. When there are discontinuity flags between fragments, the media player is expected to reset the timeline, resulting in the next fragment being played immediately after the previous fragment.

The following modes are supported:

• ALWAYS: a discontinuity marker is placed between every fragment in the HLS media playlist. It is recommended to use a value of ALWAYS if the fragment timestamps are not accurate.

• NEVER: no discontinuity markers are placed anywhere. It is recommended to use a value of NEVER to ensure the media player timeline most accurately maps to the producer timestamps.

• ON_DISCONTINUITY: a discontinuity marker is placed between fragments that have a gap or overlap of more than 50 milliseconds. For most playback scenarios, it is recommended to use a value of ON_DISCONTINUITY so that the media player timeline is only reset when there is a significant issue with the media timeline (e.g. a missing fragment).

The default is ALWAYS when HLSFragmentSelector is set to SERVER_TIMESTAMP, and NEVER when it is set to PRODUCER_TIMESTAMP.

Constraints:
Allowed Values: ALWAYS, NEVER, ON_DISCONTINUITY

displayFragmentTimestamp

java.lang.String displayFragmentTimestamp

Specifies when the fragment start timestamps should be included in the HLS media playlist. Typically, media players report the playhead position as a time relative to the start of the first fragment in the playback session. However, when the start timestamps are included in the HLS media playlist, some media players might report the current playhead as an absolute time based on the fragment timestamps. This can be useful for creating a playback experience that shows viewers the wall-clock time of the media.

The default is NEVER. When HLSFragmentSelector is SERVER_TIMESTAMP, the timestamps will be the server start timestamps. Similarly, when HLSFragmentSelector is PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.

Constraints:
Allowed Values: ALWAYS, NEVER

expires

java.lang.Integer expires

The time in seconds until the requested session expires. This value can be between 300 (5 minutes) and 43200 (12 hours).

When a session expires, no new calls to GetHLSMasterPlaylist, GetHLSMediaPlaylist, GetMP4InitFragment, GetMP4MediaFragment, or GetTSFragment can be made for that session.

The default is 300 (5 minutes).

Constraints:
Range: 300 - 43200

hLSFragmentSelector

HLSFragmentSelector hLSFragmentSelector

The time range of the requested fragment and the source of the timestamps.

This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This parameter is optional if PlaybackMode is LIVE. If PlaybackMode is LIVE, the FragmentSelectorType can be set, but the TimestampRange should not be set. If PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and TimestampRange must be set.

maxMediaPlaylistFragmentResults

java.lang.Long maxMediaPlaylistFragmentResults

The maximum number of fragments that are returned in the HLS media playlists.

When the PlaybackMode is LIVE, the most recent fragments are returned up to this value. When the PlaybackMode is ON_DEMAND, the oldest fragments are returned, up to this maximum number.

When there are a higher number of fragments available in a live HLS media playlist, video players often buffer content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the likelihood that rebuffering will occur during playback. We recommend that a live HLS media playlist have a minimum of 3 fragments and a maximum of 10 fragments.

The default is 5 fragments if PlaybackMode is LIVE or LIVE_REPLAY, and 1,000 if PlaybackMode is ON_DEMAND.

The maximum value of 5,000 fragments corresponds to more than 80 minutes of video on streams with 1-second fragments, and more than 13 hours of video on streams with 10-second fragments.

Constraints:
Range: 1 - 5000

playbackMode

java.lang.String playbackMode

Whether to retrieve live, live replay, or archived, on-demand data.

Features of the three types of sessions include the following:

• LIVE : For sessions of this type, the HLS media playlist is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new playlist on a one-second interval. When this type of session is played in a media player, the user interface typically displays a "live" notification, with no scrubber control for choosing the position in the playback window to display.

  In LIVE mode, the newest available fragments are included in an HLS media playlist, even if there is a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt or cause a jump in playback. In this mode, fragments are not added to the HLS media playlist if they are older than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment is added to the playlist, the older fragment is not added, and the gap is not filled.

• LIVE_REPLAY : For sessions of this type, the HLS media playlist is updated similarly to how it is updated for LIVE mode except that it starts by including fragments from a given start time. Instead of fragments being added as they are ingested, fragments are added as the duration of the next fragment elapses. For example, if the fragments in the session are two seconds long, then a new fragment is added to the media playlist every two seconds. This mode is useful to be able to start playback from when an event is detected and continue live streaming media that has not yet been ingested as of the time of the session creation. This mode is also useful to stream previously archived media without being limited by the 1,000 fragment limit in the ON_DEMAND mode.

• ON_DEMAND : For sessions of this type, the HLS media playlist contains all the fragments for the session, up to the number that is specified in MaxMediaPlaylistFragmentResults. The playlist must be retrieved only once for each session. When this type of session is played in a media player, the user interface typically displays a scrubber control for choosing the position in the playback window to display.

In all playback modes, if FragmentSelectorType is PRODUCER_TIMESTAMP, and if there are multiple fragments with the same start timestamp, the fragment that has the largest fragment number (that is, the newest fragment) is included in the HLS media playlist. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the HLS media playlist. This can lead to unexpected behavior in the media player.

The default is LIVE.

Constraints:
Allowed Values: LIVE, LIVE_REPLAY, ON_DEMAND

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master playlist URL.

You must specify either the StreamName or the StreamARN.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream for which to retrieve the HLS master playlist URL.

You must specify either the StreamName or the StreamARN.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.GetHLSStreamingSessionURLResult extends java.lang.Object implements Serializable

Serialized Fields

hLSStreamingSessionURL

java.lang.String hLSStreamingSessionURL

The URL (containing the session token) that a media player can use to retrieve the HLS master playlist.

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.GetImagesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endTimestamp

java.util.Date endTimestamp

The end timestamp for the range of images to be generated.

format

java.lang.String format

The format that will be used to encode the image.

Constraints:
Allowed Values: JPEG, PNG

formatConfig

java.util.Map<java.lang.String,java.lang.String> formatConfig

The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

heightPixels

java.lang.Integer heightPixels

The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

Constraints:
Range: 1 - 2160

imageSelectorType

java.lang.String imageSelectorType

The origin of the Server or Producer timestamps to use to generate the images.

Constraints:
Allowed Values: PRODUCER_TIMESTAMP, SERVER_TIMESTAMP

maxResults

java.lang.Long maxResults

The maximum number of images to be returned by the API.

The default limit is 100 images per API response. The additional results will be paginated.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

A token that specifies where to start paginating the next set of Images. This is the GetImages:NextToken from a previously truncated response.

Constraints:
Length: 1 - 4096
Pattern: [a-zA-Z0-9+/]+={0,2}

samplingInterval

java.lang.Integer samplingInterval

The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 3000 ms. If the timestamp range is less than the sampling interval, the Image from the startTimestamp will be returned if available.

The minimum value of 3000 ms is a soft limit. If needed, a lower sampling frequency can be requested.

Constraints:
Range: 3000 - 20000

startTimestamp

java.util.Date startTimestamp

The starting point from which the images should be generated. This StartTimestamp must be within an inclusive range of timestamps for an image to be returned.

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

widthPixels

java.lang.Integer widthPixels

The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided or if only the HeightPixels is provided, a ValidationException will be thrown. If neither parameter is provided, the original image size from the stream will be returned.

Constraints:
Range: 1 - 3840

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.GetImagesResult extends java.lang.Object implements Serializable

Serialized Fields

images

java.util.List<Image> images

The list of images generated from the video stream. If there is no media available for the given timestamp, the NO_MEDIA error will be listed in the output. If an error occurs while the image is being generated, the MEDIA_ERROR will be listed in the output as the cause of the missing image.

nextToken

java.lang.String nextToken

The encrypted token that was used in the request to get more images.

Constraints:
Length: 1 - 4096
Pattern: [a-zA-Z0-9+/]+={0,2}

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.GetMediaForFragmentListRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

fragments

java.util.List<java.lang.String> fragments

A list of the numbers of fragments for which to retrieve media. You retrieve these values with ListFragments.

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the stream from which to retrieve fragment media. Specify either this parameter or the StreamName parameter.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream from which to retrieve fragment media. Specify either this parameter or the StreamARN parameter.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.GetMediaForFragmentListResult extends java.lang.Object implements Serializable

Serialized Fields

contentType

java.lang.String contentType

The content type of the requested media.

Constraints:
Length: 1 - 128
Pattern: ^[a-zA-Z0-9_\.\-]+$

payload

java.io.InputStream payload

The payload that Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see PutMedia. The chunks that Kinesis Video Streams returns in the GetMediaForFragmentList call also include the following additional Matroska (MKV) tags:

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.

• AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the fragment.

• AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp of the fragment.

The following tags will be included if an exception occurs:

• AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception

• AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the exception

• AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.HLSFragmentSelector extends java.lang.Object implements Serializable

Serialized Fields

fragmentSelectorType

java.lang.String fragmentSelectorType

The source of the timestamps for the requested media.

When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode is ON_DEMAND or LIVE_REPLAY, the first fragment ingested with a producer timestamp within the specified FragmentSelector$TimestampRange is included in the media playlist. In addition, the fragments with producer timestamps within the TimestampRange ingested immediately following the first fragment (up to the GetHLSStreamingSessionURLInput$MaxMediaPlaylistFragmentResults value) are included.

Fragments that have duplicate producer timestamps are deduplicated. This means that if producers are producing a stream of fragments with producer timestamps that are approximately equal to the true clock time, the HLS media playlists will contain all of the fragments within the requested timestamp range. If some fragments are ingested within the same time range and very different points in time, only the oldest ingested collection of fragments are returned.

When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode is LIVE, the producer timestamps are used in the MP4 fragments and for deduplication. But the most recently ingested fragments based on server timestamps are included in the HLS media playlist. This means that even if fragments ingested in the past have producer timestamps with values now, they are not included in the HLS media playlist.

The default is SERVER_TIMESTAMP.

Constraints:
Allowed Values: PRODUCER_TIMESTAMP, SERVER_TIMESTAMP

timestampRange

HLSTimestampRange timestampRange

The start and end of the timestamp range for the requested media.

This value should not be present if PlaybackType is LIVE.

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.HLSTimestampRange extends java.lang.Object implements Serializable

Serialized Fields

endTimestamp

java.util.Date endTimestamp

The end of the timestamp range for the requested media. This value must be within 24 hours of the specified StartTimestamp, and it must be later than the StartTimestamp value.

If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the past.

The EndTimestamp value is required for ON_DEMAND mode, but optional for LIVE_REPLAY mode. If the EndTimestamp is not set for LIVE_REPLAY mode then the session will continue to include newly ingested fragments until the session expires.

This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment. Fragments that start before the EndTimestamp value and continue past it are included in the session.

startTimestamp

java.util.Date startTimestamp

The start of the timestamp range for the requested media.

If the HLSTimestampRange value is specified, the StartTimestamp value is required.

Only fragments that start exactly at or after StartTimestamp are included in the session. Fragments that start before StartTimestamp and continue past it aren't included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head.

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.Image extends java.lang.Object implements Serializable

Serialized Fields

error

java.lang.String error

The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

• There is no media that exists for the specified Timestamp.

• The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

Constraints:
Allowed Values: NO_MEDIA, MEDIA_ERROR

imageContent

java.lang.String imageContent

An attribute of the Image object that is Base64 encoded.

Constraints:
Length: 1 - 6291456

timeStamp

java.util.Date timeStamp

An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.InvalidArgumentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.InvalidCodecPrivateDataException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.InvalidMediaFrameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.ListFragmentsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

fragmentSelector

FragmentSelector fragmentSelector

Describes the timestamp range and timestamp origin for the range of fragments to return.

maxResults

java.lang.Long maxResults

The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination.

Constraints:
Range: 1 - 1000

nextToken

java.lang.String nextToken

A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

Constraints:
Length: 1 - 4096
Pattern: [a-zA-Z0-9+/]+={0,2}

streamARN

java.lang.String streamARN

The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamName parameter.

Constraints:
Length: 1 - 1024
Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- Z0-9_.-]+/[0-9]+

streamName

java.lang.String streamName

The name of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamARN parameter.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.ListFragmentsResult extends java.lang.Object implements Serializable

Serialized Fields

fragments

java.util.List<Fragment> fragments

A list of archived Fragment objects from the stream that meet the selector criteria. Results are in no specific order, even across pages.

nextToken

java.lang.String nextToken

If the returned list is truncated, the operation returns this token to use to retrieve the next page of results. This value is null when there are no more results to return.

Constraints:
Length: 1 - 4096
Pattern: [a-zA-Z0-9+/]+={0,2}

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.MissingCodecPrivateDataException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.NoDataRetentionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.NotAuthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.TimestampRange extends java.lang.Object implements Serializable

Serialized Fields

endTimestamp

java.util.Date endTimestamp

The ending timestamp in the range of timestamps for which to return fragments.

startTimestamp

java.util.Date startTimestamp

The starting timestamp in the range of timestamps for which to return fragments.

Class com.amazonaws.services.kinesisvideoarchivedmedia.model.UnsupportedStreamMediaTypeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.kinesisvideosignaling.model

Class com.amazonaws.services.kinesisvideosignaling.model.ClientLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideosignaling.model.GetIceServerConfigRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

channelARN

java.lang.String channelARN

The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.

Constraints:
Length: 1 - 1024
Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

clientId

java.lang.String clientId

Unique identifier for the viewer. Must be unique within the signaling channel.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

service

java.lang.String service

Specifies the desired service. Currently, TURN is the only valid value.

Constraints:
Allowed Values: TURN

username

java.lang.String username

An optional user ID to be associated with the credentials.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideosignaling.model.GetIceServerConfigResult extends java.lang.Object implements Serializable

Serialized Fields

iceServerList

java.util.List<IceServer> iceServerList

The list of ICE server information objects.

Class com.amazonaws.services.kinesisvideosignaling.model.IceServer extends java.lang.Object implements Serializable

Serialized Fields

password

java.lang.String password

A password to login to the ICE server.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

ttl

java.lang.Integer ttl

The period of time, in seconds, during which the username and password are valid.

Constraints:
Range: 30 - 86400

uris

java.util.List<java.lang.String> uris

An array of URIs, in the form specified in the I-D.petithuguenin-behave-turn-uris spec. These URIs provide the different addresses and/or protocols that can be used to reach the TURN server.

username

java.lang.String username

A username to login to the ICE server.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideosignaling.model.InvalidArgumentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideosignaling.model.InvalidClientException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideosignaling.model.NotAuthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideosignaling.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisvideosignaling.model.SendAlexaOfferToMasterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

channelARN

java.lang.String channelARN

The ARN of the signaling channel by which Alexa and the master peer communicate.

Constraints:
Length: 1 - 1024
Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

messagePayload

java.lang.String messagePayload

The base64-encoded SDP offer content.

Constraints:
Length: 1 - 10000
Pattern: [a-zA-Z0-9+/=]+

senderClientId

java.lang.String senderClientId

The unique identifier for the sender client.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Class com.amazonaws.services.kinesisvideosignaling.model.SendAlexaOfferToMasterResult extends java.lang.Object implements Serializable

Serialized Fields

answer

java.lang.String answer

The base64-encoded SDP answer content.

Constraints:
Length: 1 - 10000

Class com.amazonaws.services.kinesisvideosignaling.model.SessionExpiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.kms.model

Class com.amazonaws.services.kms.model.AliasListEntry extends java.lang.Object implements Serializable

Serialized Fields

aliasArn

java.lang.String aliasArn

String that contains the key ARN.

Constraints:
Length: 20 - 2048

aliasName

java.lang.String aliasName

String that contains the alias. This value begins with alias/.

Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$

creationDate

java.util.Date creationDate

Date and time that the alias was most recently created in the account and Region. Formatted as Unix time.

lastUpdatedDate

java.util.Date lastUpdatedDate

Date and time that the alias was most recently associated with a KMS key in the account and Region. Formatted as Unix time.

targetKeyId

java.lang.String targetKeyId

String that contains the key identifier of the KMS key associated with the alias.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.AlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.CancelKeyDeletionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyId

java.lang.String keyId

Identifies the KMS key whose deletion is being canceled.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.CancelKeyDeletionResult extends java.lang.Object implements Serializable

Serialized Fields

keyId

java.lang.String keyId

The Amazon Resource Name (key ARN) of the KMS key whose deletion is canceled.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.CloudHsmClusterInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.CloudHsmClusterInvalidConfigurationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.CloudHsmClusterNotActiveException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.CloudHsmClusterNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.CloudHsmClusterNotRelatedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.ConnectCustomKeyStoreRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customKeyStoreId

java.lang.String customKeyStoreId

Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Constraints:
Length: 1 - 64

Class com.amazonaws.services.kms.model.ConnectCustomKeyStoreResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.kms.model.CreateAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aliasName

java.lang.String aliasName

Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.

Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$

targetKeyId

java.lang.String targetKeyId

Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service Developer Guide .

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.CreateCustomKeyStoreRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cloudHsmClusterId

java.lang.String cloudHsmClusterId

Identifies the CloudHSM cluster for the custom key store. Enter the cluster ID of any active CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.

Constraints:
Length: 19 - 24

customKeyStoreName

java.lang.String customKeyStoreName

Specifies a friendly name for the custom key store. The name must be unique in your Amazon Web Services account.

Constraints:
Length: 1 - 256

keyStorePassword

java.lang.String keyStorePassword

Enter the password of the kmsuser crypto user (CU) account in the specified CloudHSM cluster. KMS logs into the cluster as this user to manage key material on your behalf.

The password must be a string of 7 to 32 characters. Its value is case sensitive.

This parameter tells KMS the kmsuser account password; it does not change the password in the CloudHSM cluster.

Constraints:
Length: 7 - 32

trustAnchorCertificate

java.lang.String trustAnchorCertificate

Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.

Constraints:
Length: 1 - 5000

Class com.amazonaws.services.kms.model.CreateCustomKeyStoreResult extends java.lang.Object implements Serializable

Serialized Fields

customKeyStoreId

java.lang.String customKeyStoreId

A unique identifier for the new custom key store.

Constraints:
Length: 1 - 64

Class com.amazonaws.services.kms.model.CreateGrantRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

constraints

GrantConstraints constraints

Specifies a grant constraint.

KMS supports the EncryptionContextEquals and EncryptionContextSubset grant constraints. Each constraint value can include up to 8 encryption context pairs. The encryption context value in each constraint cannot exceed 384 characters. For information about grant constraints, see Using grant constraints in the Key Management Service Developer Guide. For more information about encryption context, see Encryption context in the Key Management Service Developer Guide .

The encryption context grant constraints allow the permissions in the grant only when the encryption context in the request matches ( EncryptionContextEquals) or includes ( EncryptionContextSubset) the encryption context specified in this structure.

The encryption context grant constraints are supported only on grant operations that include an EncryptionContext parameter, such as cryptographic operations on symmetric encryption KMS keys. Grants with grant constraints can include the DescribeKey and RetireGrant operations, but the constraint doesn't apply to these operations. If a grant with a grant constraint includes the CreateGrant operation, the constraint requires that any grants created with the CreateGrant permission have an equally strict or stricter encryption context constraint.

You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or HMAC KMS keys. These keys don't support an encryption context.

granteePrincipal

java.lang.String granteePrincipal

The identity that gets the permissions specified in the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Constraints:
Length: 1 - 256
Pattern: ^[\w+=,.@:/-]+$

grantTokens

java.util.List<java.lang.String> grantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

keyId

java.lang.String keyId

Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

name

java.lang.String name

A friendly name for the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.

When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens for the same grant ID can be used interchangeably.

Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$

operations

java.util.List<java.lang.String> operations

A list of operations that the grant permits.

This list must include only operations that are permitted in a grant. Also, the operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric encryption KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide.

retiringPrincipal

java.lang.String retiringPrincipal

The principal that has permission to use the RetireGrant operation to retire the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.

Constraints:
Length: 1 - 256
Pattern: ^[\w+=,.@:/-]+$

Class com.amazonaws.services.kms.model.CreateGrantResult extends java.lang.Object implements Serializable

Serialized Fields

grantId

java.lang.String grantId

The unique identifier for the grant.

You can use the GrantId in a ListGrants, RetireGrant, or RevokeGrant operation.

Constraints:
Length: 1 - 128

grantToken

java.lang.String grantToken

The grant token.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Constraints:
Length: 1 - 8192

Class com.amazonaws.services.kms.model.CreateKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bypassPolicyLockoutSafetyCheck

java.lang.Boolean bypassPolicyLockoutSafetyCheck

A flag to indicate whether to bypass the key policy lockout safety check.

Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.

For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide .

Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.

The default value is false.

customerMasterKeySpec

java.lang.String customerMasterKeySpec

Instead, use the KeySpec parameter.

The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the names differ. We recommend that you use KeySpec parameter in your code. However, to avoid breaking changes, KMS will support both parameters.

Constraints:
Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT, HMAC_224, HMAC_256, HMAC_384, HMAC_512, SM2

customKeyStoreId

java.lang.String customKeyStoreId

Creates the KMS key in the specified custom key store and the key material in its associated CloudHSM cluster. To create a KMS key in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.

This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other type of KMS key in a custom key store.

To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

The response includes the custom key store ID and the ID of the CloudHSM cluster.

This operation is part of the custom key store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store.

Constraints:
Length: 1 - 64

description

java.lang.String description

A description of the KMS key.

Use a description that helps you decide whether the KMS key is appropriate for a task. The default value is an empty string (no description).

To set or change the description after the key is created, use UpdateKeyDescription.

Constraints:
Length: 0 - 8192

keySpec

java.lang.String keySpec

Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the Key Management Service Developer Guide .

The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It also determines the cryptographic algorithms that the KMS key supports. You can't change the KeySpec after the KMS key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .

Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.

KMS supports the following key specs for KMS keys:

• Symmetric encryption key (default)

  • SYMMETRIC_DEFAULT

• HMAC keys (symmetric)

  • HMAC_224

  • HMAC_256

  • HMAC_384

  • HMAC_512

• Asymmetric RSA key pairs

  • RSA_2048

  • RSA_3072

  • RSA_4096

• Asymmetric NIST-recommended elliptic curve key pairs

  • ECC_NIST_P256 (secp256r1)

  • ECC_NIST_P384 (secp384r1)

  • ECC_NIST_P521 (secp521r1)

• Other asymmetric elliptic curve key pairs

  • ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.

• SM2 key pairs (China Regions only)

  • SM2

Constraints:
Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT, HMAC_224, HMAC_256, HMAC_384, HMAC_512, SM2

keyUsage

java.lang.String keyUsage

Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is created.

Select only one valid value.

• For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.

• For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.

• For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.

• For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.

• For asymmetric KMS keys with SM2 key material (China Regions only), specify ENCRYPT_DECRYPT or SIGN_VERIFY.

Constraints:
Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT, GENERATE_VERIFY_MAC

multiRegion

java.lang.Boolean multiRegion

Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You cannot change this value after you create the KMS key.

For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this parameter or set it to False. The default value is False.

This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

This value creates a primary key, not a replica. To create a replica key, use the ReplicateKey operation.

You can create a multi-Region version of a symmetric encryption KMS key, an HMAC KMS key, an asymmetric KMS key, or a KMS key with imported key material. However, you cannot create a multi-Region key in a custom key store.

origin

java.lang.String origin

The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS, which means that KMS creates the key material.

To create a KMS key with no key material (for imported key material), set the value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. This value is valid only for symmetric encryption KMS keys.

To create a KMS key in an KMS custom key store and create its key material in the associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric encryption KMS keys.

Constraints:
Allowed Values: AWS_KMS, EXTERNAL, AWS_CLOUDHSM

policy

java.lang.String policy

The key policy to attach to the KMS key. If you do not specify a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default key policy in the Key Management Service Developer Guide.

If you provide a key policy, it must meet the following criteria:

• If you don't set BypassPolicyLockoutSafetyCheck to True, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide .

• Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.

A key policy document can include only the following characters:

• Printable ASCII characters from the space character ( ) through the end of the ASCII character range.

• Printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ).

• The tab ( ), line feed ( ), and carriage return ( ) special characters

For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .

Constraints:
Length: 1 - 131072
Pattern: [ -ÿ]+

tags

java.util.List<Tag> tags

Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

To use this parameter, you must have kms:TagResource permission in an IAM policy.

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.

Class com.amazonaws.services.kms.model.CreateKeyResult extends java.lang.Object implements Serializable

Serialized Fields

keyMetadata

KeyMetadata keyMetadata

Metadata associated with the KMS key.

Class com.amazonaws.services.kms.model.CustomKeyStoreHasCMKsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.CustomKeyStoreInvalidStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.CustomKeyStoreNameInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.CustomKeyStoreNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.CustomKeyStoresListEntry extends java.lang.Object implements Serializable

Serialized Fields

cloudHsmClusterId

java.lang.String cloudHsmClusterId

A unique identifier for the CloudHSM cluster that is associated with the custom key store.

Constraints:
Length: 19 - 24

connectionErrorCode

java.lang.String connectionErrorCode

Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in Key Management Service Developer Guide.

Valid values are:

• CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.

• INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.

• INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.

• INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.

• NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.

• SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.

• USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.

• USER_LOGGED_IN - The kmsuser CU account is logged into the the associated CloudHSM cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the Key Management Service Developer Guide.

• USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.

Constraints:
Allowed Values: INVALID_CREDENTIALS, CLUSTER_NOT_FOUND, NETWORK_ERRORS, INTERNAL_ERROR, INSUFFICIENT_CLOUDHSM_HSMS, USER_LOCKED_OUT, USER_NOT_FOUND, USER_LOGGED_IN, SUBNET_NOT_FOUND, INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET

connectionState

java.lang.String connectionState

Indicates whether the custom key store is connected to its CloudHSM cluster.

You can create and use KMS keys in your custom key stores only when its connection state is CONNECTED.

The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains at least one active HSM.

A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the Key Management Service Developer Guide.

Constraints:
Allowed Values: CONNECTED, CONNECTING, FAILED, DISCONNECTED, DISCONNECTING

creationDate

java.util.Date creationDate

The date and time when the custom key store was created.

customKeyStoreId

java.lang.String customKeyStoreId

A unique identifier for the custom key store.

Constraints:
Length: 1 - 64

customKeyStoreName

java.lang.String customKeyStoreName

The user-specified friendly name for the custom key store.

Constraints:
Length: 1 - 256

trustAnchorCertificate

java.lang.String trustAnchorCertificate

The trust anchor certificate of the associated CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.

Constraints:
Length: 1 - 5000

Class com.amazonaws.services.kms.model.DecryptRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ciphertextBlob

java.nio.ByteBuffer ciphertextBlob

Ciphertext to be decrypted. The blob includes metadata.

Constraints:
Length: 1 - 6144

encryptionAlgorithm

java.lang.String encryptionAlgorithm

Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric encryption KMS keys.

Constraints:
Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256, SM2PKE

encryptionContext

java.util.Map<java.lang.String,java.lang.String> encryptionContext

Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

grantTokens

java.util.List<java.lang.String> grantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

keyId

java.lang.String keyId

Specifies the KMS key that KMS uses to decrypt the ciphertext.

Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the Decrypt operation throws an IncorrectKeyException.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.DecryptResult extends java.lang.Object implements Serializable

Serialized Fields

encryptionAlgorithm

java.lang.String encryptionAlgorithm

The encryption algorithm that was used to decrypt the ciphertext.

Constraints:
Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256, SM2PKE

keyId

java.lang.String keyId

The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.

Constraints:
Length: 1 - 2048

plaintext

java.nio.ByteBuffer plaintext

Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Constraints:
Length: 1 - 4096

Class com.amazonaws.services.kms.model.DeleteAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aliasName

java.lang.String aliasName

The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.

Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$

Class com.amazonaws.services.kms.model.DeleteCustomKeyStoreRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customKeyStoreId

java.lang.String customKeyStoreId

Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Constraints:
Length: 1 - 64

Class com.amazonaws.services.kms.model.DeleteCustomKeyStoreResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.kms.model.DeleteImportedKeyMaterialRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyId

java.lang.String keyId

Identifies the KMS key from which you are deleting imported key material. The Origin of the KMS key must be EXTERNAL.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.DependencyTimeoutException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.DescribeCustomKeyStoresRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customKeyStoreId

java.lang.String customKeyStoreId

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and Region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Constraints:
Length: 1 - 64

customKeyStoreName

java.lang.String customKeyStoreName

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and Region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Constraints:
Length: 1 - 256

limit

java.lang.Integer limit

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

Constraints:
Range: 1 - 1000

marker

java.lang.String marker

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

Class com.amazonaws.services.kms.model.DescribeCustomKeyStoresResult extends java.lang.Object implements Serializable

Serialized Fields

customKeyStores

java.util.List<CustomKeyStoresListEntry> customKeyStores

Contains metadata about each custom key store.

nextMarker

java.lang.String nextMarker

When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

truncated

java.lang.Boolean truncated

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

Class com.amazonaws.services.kms.model.DescribeKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

grantTokens

java.util.List<java.lang.String> grantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

keyId

java.lang.String keyId

Describes the specified KMS key.

If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), KMS associates the alias with an Amazon Web Services managed key and returns its KeyId and Arn in the response.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.DescribeKeyResult extends java.lang.Object implements Serializable

Serialized Fields

keyMetadata

KeyMetadata keyMetadata

Metadata associated with the key.

Class com.amazonaws.services.kms.model.DisabledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.DisableKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyId

java.lang.String keyId

Identifies the KMS key to disable.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.DisableKeyRotationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyId

java.lang.String keyId

Identifies a symmetric encryption KMS key. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.DisconnectCustomKeyStoreRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customKeyStoreId

java.lang.String customKeyStoreId

Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Constraints:
Length: 1 - 64

Class com.amazonaws.services.kms.model.DisconnectCustomKeyStoreResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.kms.model.EnableKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyId

java.lang.String keyId

Identifies the KMS key to enable.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.EnableKeyRotationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyId

java.lang.String keyId

Identifies a symmetric encryption KMS key. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. The key rotation status of these KMS keys is always false. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.EncryptRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

encryptionAlgorithm

java.lang.String encryptionAlgorithm

Specifies the encryption algorithm that KMS will use to encrypt the plaintext message. The algorithm must be compatible with the KMS key that you specify.

This parameter is required only for asymmetric KMS keys. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric encryption KMS keys. If you are using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.

Constraints:
Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256, SM2PKE

encryptionContext

java.util.Map<java.lang.String,java.lang.String> encryptionContext

Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

grantTokens

java.util.List<java.lang.String> grantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

keyId

java.lang.String keyId

Identifies the KMS key to use in the encryption operation. The KMS key must have a KeyUsage of ENCRYPT_DECRYPT. To find the KeyUsage of a KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Constraints:
Length: 1 - 2048

plaintext

java.nio.ByteBuffer plaintext

Data to be encrypted.

Constraints:
Length: 1 - 4096

Class com.amazonaws.services.kms.model.EncryptResult extends java.lang.Object implements Serializable

Serialized Fields

ciphertextBlob

java.nio.ByteBuffer ciphertextBlob

The encrypted plaintext. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Constraints:
Length: 1 - 6144

encryptionAlgorithm

java.lang.String encryptionAlgorithm

The encryption algorithm that was used to encrypt the plaintext.

Constraints:
Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256, SM2PKE

keyId

java.lang.String keyId

The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.ExpiredImportTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.GenerateDataKeyPairRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

encryptionContext

java.util.Map<java.lang.String,java.lang.String> encryptionContext

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

grantTokens

java.util.List<java.lang.String> grantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

keyId

java.lang.String keyId

Specifies the symmetric encryption KMS key that encrypts the private key in the data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Constraints:
Length: 1 - 2048

keyPairSpec

java.lang.String keyPairSpec

Determines the type of data key pair that is generated.

The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions. RSA and ECC asymmetric key pairs are also available in China Regions.

Constraints:
Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SM2

Class com.amazonaws.services.kms.model.GenerateDataKeyPairResult extends java.lang.Object implements Serializable

Serialized Fields

keyId

java.lang.String keyId

The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.

Constraints:
Length: 1 - 2048

keyPairSpec

java.lang.String keyPairSpec

The type of data key pair that was generated.

Constraints:
Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SM2

privateKeyCiphertextBlob

java.nio.ByteBuffer privateKeyCiphertextBlob

The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Constraints:
Length: 1 - 6144

privateKeyPlaintext

java.nio.ByteBuffer privateKeyPlaintext

The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Constraints:
Length: 1 - 4096

publicKey

java.nio.ByteBuffer publicKey

The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Constraints:
Length: 1 - 8192

Class com.amazonaws.services.kms.model.GenerateDataKeyPairWithoutPlaintextRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

encryptionContext

java.util.Map<java.lang.String,java.lang.String> encryptionContext

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

grantTokens

java.util.List<java.lang.String> grantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

keyId

java.lang.String keyId

Specifies the symmetric encryption KMS key that encrypts the private key in the data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Constraints:
Length: 1 - 2048

keyPairSpec

java.lang.String keyPairSpec

Determines the type of data key pair that is generated.

The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions. RSA and ECC asymmetric key pairs are also available in China Regions.

Constraints:
Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SM2

Class com.amazonaws.services.kms.model.GenerateDataKeyPairWithoutPlaintextResult extends java.lang.Object implements Serializable

Serialized Fields

keyId

java.lang.String keyId

The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.

Constraints:
Length: 1 - 2048

keyPairSpec

java.lang.String keyPairSpec

The type of data key pair that was generated.

Constraints:
Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SM2

privateKeyCiphertextBlob

java.nio.ByteBuffer privateKeyCiphertextBlob

The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Constraints:
Length: 1 - 6144

publicKey

java.nio.ByteBuffer publicKey

The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Constraints:
Length: 1 - 8192

Class com.amazonaws.services.kms.model.GenerateDataKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

encryptionContext

java.util.Map<java.lang.String,java.lang.String> encryptionContext

Specifies the encryption context that will be used when encrypting the data key.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

grantTokens

java.util.List<java.lang.String> grantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

keyId

java.lang.String keyId

Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Constraints:
Length: 1 - 2048

keySpec

java.lang.String keySpec

Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

Constraints:
Allowed Values: AES_256, AES_128

numberOfBytes

java.lang.Integer numberOfBytes

Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the KeySpec parameter.

You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

Constraints:
Range: 1 - 1024

Class com.amazonaws.services.kms.model.GenerateDataKeyResult extends java.lang.Object implements Serializable

Serialized Fields

ciphertextBlob

java.nio.ByteBuffer ciphertextBlob

The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Constraints:
Length: 1 - 6144

keyId

java.lang.String keyId

The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.

Constraints:
Length: 1 - 2048

plaintext

java.nio.ByteBuffer plaintext

The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.

Constraints:
Length: 1 - 4096

Class com.amazonaws.services.kms.model.GenerateDataKeyWithoutPlaintextRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

encryptionContext

java.util.Map<java.lang.String,java.lang.String> encryptionContext

Specifies the encryption context that will be used when encrypting the data key.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

grantTokens

java.util.List<java.lang.String> grantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

keyId

java.lang.String keyId

Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Constraints:
Length: 1 - 2048

keySpec

java.lang.String keySpec

The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

Constraints:
Allowed Values: AES_256, AES_128

numberOfBytes

java.lang.Integer numberOfBytes

The length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.

Constraints:
Range: 1 - 1024

Class com.amazonaws.services.kms.model.GenerateDataKeyWithoutPlaintextResult extends java.lang.Object implements Serializable

Serialized Fields

ciphertextBlob

java.nio.ByteBuffer ciphertextBlob

The encrypted data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Constraints:
Length: 1 - 6144

keyId

java.lang.String keyId

The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.GenerateMacRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

grantTokens

java.util.List<java.lang.String> grantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

keyId

java.lang.String keyId

The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104.

To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field in the response.

Constraints:
Length: 1 - 2048

macAlgorithm

java.lang.String macAlgorithm

The MAC algorithm used in the operation.

The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the DescribeKey response.

Constraints:
Allowed Values: HMAC_SHA_224, HMAC_SHA_256, HMAC_SHA_384, HMAC_SHA_512

message

java.nio.ByteBuffer message

The message to be hashed. Specify a message of up to 4,096 bytes.

GenerateMac and VerifyMac do not provide special handling for message digests. If you generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.

Constraints:
Length: 1 - 4096

Class com.amazonaws.services.kms.model.GenerateMacResult extends java.lang.Object implements Serializable

Serialized Fields

keyId

java.lang.String keyId

The HMAC KMS key used in the operation.

Constraints:
Length: 1 - 2048

mac

java.nio.ByteBuffer mac

The hash-based message authentication code (HMAC) for the given message, key, and MAC algorithm.

Constraints:
Length: 1 - 6144

macAlgorithm

java.lang.String macAlgorithm

The MAC algorithm that was used to generate the HMAC.

Constraints:
Allowed Values: HMAC_SHA_224, HMAC_SHA_256, HMAC_SHA_384, HMAC_SHA_512

Class com.amazonaws.services.kms.model.GenerateRandomRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customKeyStoreId

java.lang.String customKeyStoreId

Generates the random byte string in the CloudHSM cluster that is associated with the specified custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Constraints:
Length: 1 - 64

numberOfBytes

java.lang.Integer numberOfBytes

The length of the random byte string. This parameter is required.

Constraints:
Range: 1 - 1024

Class com.amazonaws.services.kms.model.GenerateRandomResult extends java.lang.Object implements Serializable

Serialized Fields

plaintext

java.nio.ByteBuffer plaintext

The random byte string. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Constraints:
Length: 1 - 4096

Class com.amazonaws.services.kms.model.GetKeyPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyId

java.lang.String keyId

Gets the key policy for the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

policyName

java.lang.String policyName

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

Constraints:
Length: 1 - 128
Pattern: [\w]+

Class com.amazonaws.services.kms.model.GetKeyPolicyResult extends java.lang.Object implements Serializable

Serialized Fields

policy

java.lang.String policy

A key policy document in JSON format.

Constraints:
Length: 1 - 131072
Pattern: [ -ÿ]+

Class com.amazonaws.services.kms.model.GetKeyRotationStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyId

java.lang.String keyId

Gets the rotation status for the specified KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.GetKeyRotationStatusResult extends java.lang.Object implements Serializable

Serialized Fields

keyRotationEnabled

java.lang.Boolean keyRotationEnabled

A Boolean value that specifies whether key rotation is enabled.

Class com.amazonaws.services.kms.model.GetParametersForImportRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyId

java.lang.String keyId

The identifier of the symmetric encryption KMS key into which you will import key material. The Origin of the KMS key must be EXTERNAL.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

wrappingAlgorithm

java.lang.String wrappingAlgorithm

The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the Key Management Service Developer Guide.

Constraints:
Allowed Values: RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256

wrappingKeySpec

java.lang.String wrappingKeySpec

The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.

Constraints:
Allowed Values: RSA_2048

Class com.amazonaws.services.kms.model.GetParametersForImportResult extends java.lang.Object implements Serializable

Serialized Fields

importToken

java.nio.ByteBuffer importToken

The import token to send in a subsequent ImportKeyMaterial request.

Constraints:
Length: 1 - 6144

keyId

java.lang.String keyId

The Amazon Resource Name (key ARN) of the KMS key to use in a subsequent ImportKeyMaterial request. This is the same KMS key specified in the GetParametersForImport request.

Constraints:
Length: 1 - 2048

parametersValidTo

java.util.Date parametersValidTo

The time at which the import token and public key are no longer valid. After this time, you cannot use them to make an ImportKeyMaterial request and you must send another GetParametersForImport request to get new ones.

publicKey

java.nio.ByteBuffer publicKey

The public key to use to encrypt the key material before importing it with ImportKeyMaterial.

Constraints:
Length: 1 - 4096

Class com.amazonaws.services.kms.model.GetPublicKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

grantTokens

java.util.List<java.lang.String> grantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

keyId

java.lang.String keyId

Identifies the asymmetric KMS key that includes the public key.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.GetPublicKeyResult extends java.lang.Object implements Serializable

Serialized Fields

customerMasterKeySpec

java.lang.String customerMasterKeySpec

Instead, use the KeySpec field in the GetPublicKey response.

The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS will support both fields.

Constraints:
Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT, HMAC_224, HMAC_256, HMAC_384, HMAC_512, SM2

encryptionAlgorithms

java.util.List<java.lang.String> encryptionAlgorithms

The encryption algorithms that KMS supports for this key.

This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

keyId

java.lang.String keyId

The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.

Constraints:
Length: 1 - 2048

keySpec

java.lang.String keySpec

The type of the of the public key that was downloaded.

Constraints:
Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT, HMAC_224, HMAC_256, HMAC_384, HMAC_512, SM2

keyUsage

java.lang.String keyUsage

The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or SIGN_VERIFY.

This information is critical. If a public key with SIGN_VERIFY key usage encrypts data outside of KMS, the ciphertext cannot be decrypted.

Constraints:
Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT, GENERATE_VERIFY_MAC

publicKey

java.nio.ByteBuffer publicKey

The exported public key.

The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as defined in RFC 5280. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Constraints:
Length: 1 - 8192

signingAlgorithms

java.util.List<java.lang.String> signingAlgorithms

The signing algorithms that KMS supports for this key.

This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

Class com.amazonaws.services.kms.model.GrantConstraints extends java.lang.Object implements Serializable

Serialized Fields

encryptionContextEquals

java.util.Map<java.lang.String,java.lang.String> encryptionContextEquals

A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.

encryptionContextSubset

java.util.Map<java.lang.String,java.lang.String> encryptionContextSubset

A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.

Class com.amazonaws.services.kms.model.GrantListEntry extends java.lang.Object implements Serializable

Serialized Fields

constraints

GrantConstraints constraints

A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

creationDate

java.util.Date creationDate

The date and time when the grant was created.

granteePrincipal

java.lang.String granteePrincipal

The identity that gets the permissions in the grant.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.

Constraints:
Length: 1 - 256
Pattern: ^[\w+=,.@:/-]+$

grantId

java.lang.String grantId

The unique identifier for the grant.

Constraints:
Length: 1 - 128

issuingAccount

java.lang.String issuingAccount

The Amazon Web Services account under which the grant was issued.

Constraints:
Length: 1 - 256
Pattern: ^[\w+=,.@:/-]+$

keyId

java.lang.String keyId

The unique identifier for the KMS key to which the grant applies.

Constraints:
Length: 1 - 2048

name

java.lang.String name

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$

operations

java.util.List<java.lang.String> operations

The list of operations permitted by the grant.

retiringPrincipal

java.lang.String retiringPrincipal

The principal that can retire the grant.

Constraints:
Length: 1 - 256
Pattern: ^[\w+=,.@:/-]+$

Class com.amazonaws.services.kms.model.ImportKeyMaterialRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

encryptedKeyMaterial

java.nio.ByteBuffer encryptedKeyMaterial

The encrypted key material to import. The key material must be encrypted with the public wrapping key that GetParametersForImport returned, using the wrapping algorithm that you specified in the same GetParametersForImport request.

Constraints:
Length: 1 - 6144

expirationModel

java.lang.String expirationModel

Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES, in which case you must include the ValidTo parameter. When this parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.

Constraints:
Allowed Values: KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE

importToken

java.nio.ByteBuffer importToken

The import token that you received in the response to a previous GetParametersForImport request. It must be from the same response that contained the public key that you used to encrypt the key material.

Constraints:
Length: 1 - 6144

keyId

java.lang.String keyId

The identifier of the symmetric encryption KMS key that receives the imported key material. This must be the same KMS key specified in the KeyID parameter of the corresponding GetParametersForImport request. The Origin of the KMS key must be EXTERNAL. You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, a KMS key in a custom key store, or on a KMS key in a different Amazon Web Services account

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

validTo

java.util.Date validTo

The time at which the imported key material expires. When the key material expires, KMS deletes the key material and the KMS key becomes unusable. You must omit this parameter when the ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE. Otherwise it is required.

Class com.amazonaws.services.kms.model.ImportKeyMaterialResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.kms.model.IncorrectKeyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.IncorrectKeyMaterialException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.IncorrectTrustAnchorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.InvalidAliasNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.InvalidArnException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.InvalidCiphertextException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.InvalidGrantIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.InvalidGrantTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.InvalidImportTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.InvalidKeyUsageException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.InvalidMarkerException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.KeyListEntry extends java.lang.Object implements Serializable

Serialized Fields

keyArn

java.lang.String keyArn

ARN of the key.

Constraints:
Length: 20 - 2048

keyId

java.lang.String keyId

Unique identifier of the key.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.KeyMetadata extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the Amazon Web Services General Reference.

Constraints:
Length: 20 - 2048

aWSAccountId

java.lang.String aWSAccountId

The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

cloudHsmClusterId

java.lang.String cloudHsmClusterId

The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in a custom key store, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This value is present only when the KMS key is created in a custom key store.

Constraints:
Length: 19 - 24

creationDate

java.util.Date creationDate

The date and time when the KMS key was created.

customerMasterKeySpec

java.lang.String customerMasterKeySpec

Instead, use the KeySpec field.

The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS will support both fields.

Constraints:
Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT, HMAC_224, HMAC_256, HMAC_384, HMAC_512, SM2

customKeyStoreId

java.lang.String customKeyStoreId

A unique identifier for the custom key store that contains the KMS key. This value is present only when the KMS key is created in a custom key store.

Constraints:
Length: 1 - 64

deletionDate

java.util.Date deletionDate

The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState is PendingDeletion.

When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion and the length of its waiting period is displayed in the PendingDeletionWindowInDays field.

description

java.lang.String description

The description of the KMS key.

Constraints:
Length: 0 - 8192

enabled

java.lang.Boolean enabled

Specifies whether the KMS key is enabled. When KeyState is Enabled this value is true, otherwise it is false.

encryptionAlgorithms

java.util.List<java.lang.String> encryptionAlgorithms

The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.

This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.

expirationModel

java.lang.String expirationModel

Specifies whether the KMS key's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

Constraints:
Allowed Values: KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE

keyId

java.lang.String keyId

The globally unique identifier for the KMS key.

Constraints:
Length: 1 - 2048

keyManager

java.lang.String keyManager

The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.

Constraints:
Allowed Values: AWS, CUSTOMER

keySpec

java.lang.String keySpec

Describes the type of key material in the KMS key.

Constraints:
Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT, HMAC_224, HMAC_256, HMAC_384, HMAC_512, SM2

keyState

java.lang.String keyState

The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

Constraints:
Allowed Values: Creating, Enabled, Disabled, PendingDeletion, PendingImport, PendingReplicaDeletion, Unavailable, Updating

keyUsage

java.lang.String keyUsage

The cryptographic operations for which you can use the KMS key.

Constraints:
Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT, GENERATE_VERIFY_MAC

macAlgorithms

java.util.List<java.lang.String> macAlgorithms

The message authentication code (MAC) algorithm that the HMAC KMS key supports.

This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.

multiRegion

java.lang.Boolean multiRegion

Indicates whether the KMS key is a multi-Region (True) or regional (False) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.

For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

multiRegionConfiguration

MultiRegionConfiguration multiRegionConfiguration

Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the MultiRegion field is True.

For more information about any listed KMS key, use the DescribeKey operation.

• MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA key.

• PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.

• ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

origin

java.lang.String origin

The source of the key material for the KMS key. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

Constraints:
Allowed Values: AWS_KMS, EXTERNAL, AWS_CLOUDHSM

pendingDeletionWindowInDays

java.lang.Integer pendingDeletionWindowInDays

The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is PendingReplicaDeletion. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.

When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the DeletionDate field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion to PendingDeletion and the deletion date appears in the DeletionDate field.

Constraints:
Range: 1 - 365

signingAlgorithms

java.util.List<java.lang.String> signingAlgorithms

The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.

This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.

validTo

java.util.Date validTo

The time at which the imported key material expires. When the key material expires, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

Class com.amazonaws.services.kms.model.KeyUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.KMSInternalException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.KMSInvalidMacException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.KMSInvalidSignatureException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.KMSInvalidStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.ListAliasesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyId

java.lang.String keyId

Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your Amazon Web Services account.

This parameter is optional. If you omit it, ListAliases returns all aliases in the account and Region.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

limit

java.lang.Integer limit

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

Constraints:
Range: 1 - 1000

marker

java.lang.String marker

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

Class com.amazonaws.services.kms.model.ListAliasesResult extends java.lang.Object implements Serializable

Serialized Fields

aliases

java.util.List<AliasListEntry> aliases

A list of aliases.

nextMarker

java.lang.String nextMarker

When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

truncated

java.lang.Boolean truncated

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

Class com.amazonaws.services.kms.model.ListGrantsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

granteePrincipal

java.lang.String granteePrincipal

Returns only grants where the specified principal is the grantee principal for the grant.

Constraints:
Length: 1 - 256
Pattern: ^[\w+=,.@:/-]+$

grantId

java.lang.String grantId

Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

Constraints:
Length: 1 - 128

keyId

java.lang.String keyId

Returns only grants for the specified KMS key. This parameter is required.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

limit

java.lang.Integer limit

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

Constraints:
Range: 1 - 1000

marker

java.lang.String marker

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

Class com.amazonaws.services.kms.model.ListGrantsResult extends java.lang.Object implements Serializable

Serialized Fields

grants

java.util.List<GrantListEntry> grants

A list of grants.

nextMarker

java.lang.String nextMarker

When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

truncated

java.lang.Boolean truncated

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

Class com.amazonaws.services.kms.model.ListKeyPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyId

java.lang.String keyId

Gets the names of key policies for the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

limit

java.lang.Integer limit

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

Only one policy can be attached to a key.

Constraints:
Range: 1 - 1000

marker

java.lang.String marker

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

Class com.amazonaws.services.kms.model.ListKeyPoliciesResult extends java.lang.Object implements Serializable

Serialized Fields

nextMarker

java.lang.String nextMarker

When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

policyNames

java.util.List<java.lang.String> policyNames

A list of key policy names. The only valid value is default.

truncated

java.lang.Boolean truncated

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

Class com.amazonaws.services.kms.model.ListKeysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

limit

java.lang.Integer limit

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

Constraints:
Range: 1 - 1000

marker

java.lang.String marker

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

Class com.amazonaws.services.kms.model.ListKeysResult extends java.lang.Object implements Serializable

Serialized Fields

keys

java.util.List<KeyListEntry> keys

A list of KMS keys.

nextMarker

java.lang.String nextMarker

When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

truncated

java.lang.Boolean truncated

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

Class com.amazonaws.services.kms.model.ListResourceTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyId

java.lang.String keyId

Gets tags on the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

limit

java.lang.Integer limit

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 50, inclusive. If you do not include a value, it defaults to 50.

Constraints:
Range: 1 - 1000

marker

java.lang.String marker

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Do not attempt to construct this value. Use only the value of NextMarker from the truncated response you just received.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

Class com.amazonaws.services.kms.model.ListResourceTagsResult extends java.lang.Object implements Serializable

Serialized Fields

nextMarker

java.lang.String nextMarker

When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

Do not assume or infer any information from this value.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

tags

java.util.List<Tag> tags

A list of tags. Each tag consists of a tag key and a tag value.

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

truncated

java.lang.Boolean truncated

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

Class com.amazonaws.services.kms.model.ListRetirableGrantsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

limit

java.lang.Integer limit

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

Constraints:
Range: 1 - 1000

marker

java.lang.String marker

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

retiringPrincipal

java.lang.String retiringPrincipal

The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Constraints:
Length: 1 - 256
Pattern: ^[\w+=,.@:/-]+$

Class com.amazonaws.services.kms.model.ListRetirableGrantsResult extends java.lang.Object implements Serializable

Serialized Fields

grants

java.util.List<GrantListEntry> grants

A list of grants.

nextMarker

java.lang.String nextMarker

When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

truncated

java.lang.Boolean truncated

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

Class com.amazonaws.services.kms.model.MalformedPolicyDocumentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.MultiRegionConfiguration extends java.lang.Object implements Serializable

Serialized Fields

multiRegionKeyType

java.lang.String multiRegionKeyType

Indicates whether the KMS key is a PRIMARY or REPLICA key.

Constraints:
Allowed Values: PRIMARY, REPLICA

primaryKey

MultiRegionKey primaryKey

Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.

replicaKeys

java.util.List<MultiRegionKey> replicaKeys

displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

Class com.amazonaws.services.kms.model.MultiRegionKey extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

Displays the key ARN of a primary or replica key of a multi-Region key.

Constraints:
Length: 20 - 2048

region

java.lang.String region

Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.

Constraints:
Length: 1 - 32
Pattern: ^([a-z]+-){2,3}\d+$

Class com.amazonaws.services.kms.model.NotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.PutKeyPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bypassPolicyLockoutSafetyCheck

java.lang.Boolean bypassPolicyLockoutSafetyCheck

A flag to indicate whether to bypass the key policy lockout safety check.

Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.

For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.

Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.

The default value is false.

keyId

java.lang.String keyId

Sets the key policy on the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

policy

java.lang.String policy

The key policy to attach to the KMS key.

The key policy must meet the following criteria:

• If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide.

• Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.

A key policy document can include only the following characters:

• Printable ASCII characters from the space character ( ) through the end of the ASCII character range.

• Printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ).

• The tab ( ), line feed ( ), and carriage return ( ) special characters

For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .

Constraints:
Length: 1 - 131072
Pattern: [ -ÿ]+

policyName

java.lang.String policyName

The name of the key policy. The only valid value is default.

Constraints:
Length: 1 - 128
Pattern: [\w]+

Class com.amazonaws.services.kms.model.ReEncryptRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ciphertextBlob

java.nio.ByteBuffer ciphertextBlob

Ciphertext of the data to reencrypt.

Constraints:
Length: 1 - 6144

destinationEncryptionAlgorithm

java.lang.String destinationEncryptionAlgorithm

Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption algorithm used for symmetric encryption KMS keys.

This parameter is required only when the destination KMS key is an asymmetric KMS key.

Constraints:
Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256, SM2PKE

destinationEncryptionContext

java.util.Map<java.lang.String,java.lang.String> destinationEncryptionContext

Specifies that encryption context to use when the reencrypting the data.

A destination encryption context is valid only when the destination KMS key is a symmetric encryption KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for metadata.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

destinationKeyId

java.lang.String destinationKeyId

A unique identifier for the KMS key that is used to reencrypt the data. Specify a symmetric encryption KMS key or an asymmetric KMS key with a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage value of a KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Constraints:
Length: 1 - 2048

grantTokens

java.util.List<java.lang.String> grantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

sourceEncryptionAlgorithm

java.lang.String sourceEncryptionAlgorithm

Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm used for symmetric encryption KMS keys.

Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.

Constraints:
Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256, SM2PKE

sourceEncryptionContext

java.util.Map<java.lang.String,java.lang.String> sourceEncryptionContext

Specifies the encryption context to use to decrypt the ciphertext. Enter the same encryption context that was used to encrypt the ciphertext.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

sourceKeyId

java.lang.String sourceKeyId

Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted.

Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the ReEncrypt operation throws an IncorrectKeyException.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.ReEncryptResult extends java.lang.Object implements Serializable

Serialized Fields

ciphertextBlob

java.nio.ByteBuffer ciphertextBlob

The reencrypted data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Constraints:
Length: 1 - 6144

destinationEncryptionAlgorithm

java.lang.String destinationEncryptionAlgorithm

The encryption algorithm that was used to reencrypt the data.

Constraints:
Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256, SM2PKE

keyId

java.lang.String keyId

The Amazon Resource Name (key ARN) of the KMS key that was used to reencrypt the data.

Constraints:
Length: 1 - 2048

sourceEncryptionAlgorithm

java.lang.String sourceEncryptionAlgorithm

The encryption algorithm that was used to decrypt the ciphertext before it was reencrypted.

Constraints:
Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256, SM2PKE

sourceKeyId

java.lang.String sourceKeyId

Unique identifier of the KMS key used to originally encrypt the data.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.ReplicateKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bypassPolicyLockoutSafetyCheck

java.lang.Boolean bypassPolicyLockoutSafetyCheck

A flag to indicate whether to bypass the key policy lockout safety check.

Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.

For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.

Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.

The default value is false.

description

java.lang.String description

A description of the KMS key. The default value is an empty string (no description).

The description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. KMS does not synchronize this property.

Constraints:
Length: 0 - 8192

keyId

java.lang.String keyId

Identifies the multi-Region primary key that is being replicated. To determine whether a KMS key is a multi-Region primary key, use the DescribeKey operation to check the value of the MultiRegionKeyType property.

Specify the key ID or key ARN of a multi-Region primary key.

For example:

• Key ID: mrk-1234abcd12ab34cd56ef1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

policy

java.lang.String policy

The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.

The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.

If you provide a key policy, it must meet the following criteria:

• If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide .

• Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Identity and Access Management User Guide .

A key policy document can include only the following characters:

• Printable ASCII characters from the space character ( ) through the end of the ASCII character range.

• Printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ).

• The tab ( ), line feed ( ), and carriage return ( ) special characters

For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .

Constraints:
Length: 1 - 131072
Pattern: [ -ÿ]+

replicaRegion

java.lang.String replicaRegion

The Region ID of the Amazon Web Services Region for this replica key.

Enter the Region ID, such as us-east-1 or ap-southeast-2. For a list of Amazon Web Services Regions in which KMS is supported, see KMS service endpoints in the Amazon Web Services General Reference.

HMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to replicate an HMAC KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the ReplicateKey operation returns an UnsupportedOperationException. For a list of Regions in which HMAC KMS keys are supported, see HMAC keys in KMS in the Key Management Service Developer Guide.

The replica must be in a different Amazon Web Services Region than its primary key and other replicas of that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the Region. For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a Region and Disabling a Region in the Amazon Web Services General Reference.

Constraints:
Length: 1 - 32
Pattern: ^([a-z]+-){2,3}\d+$

tags

java.util.List<Tag> tags

Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

To use this parameter, you must have kms:TagResource permission in an IAM policy.

Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. KMS does not synchronize this property.

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.

Class com.amazonaws.services.kms.model.ReplicateKeyResult extends java.lang.Object implements Serializable

Serialized Fields

replicaKeyMetadata

KeyMetadata replicaKeyMetadata

Displays details about the new replica key, including its Amazon Resource Name (key ARN) and Key states of KMS keys. It also includes the ARN and Amazon Web Services Region of its primary key and other replica keys.

replicaPolicy

java.lang.String replicaPolicy

The key policy of the new replica key. The value is a key policy document in JSON format.

Constraints:
Length: 1 - 131072
Pattern: [ -ÿ]+

replicaTags

java.util.List<Tag> replicaTags

The tags on the new replica key. The value is a list of tag key and tag value pairs.

Class com.amazonaws.services.kms.model.RetireGrantRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

grantId

java.lang.String grantId

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Constraints:
Length: 1 - 128

grantToken

java.lang.String grantToken

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

Constraints:
Length: 1 - 8192

keyId

java.lang.String keyId

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.RevokeGrantRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

grantId

java.lang.String grantId

Identifies the grant to revoke. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

Constraints:
Length: 1 - 128

keyId

java.lang.String keyId

A unique identifier for the KMS key associated with the grant. To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.ScheduleKeyDeletionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyId

java.lang.String keyId

The unique identifier of the KMS key to delete.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

pendingWindowInDays

java.lang.Integer pendingWindowInDays

The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.

If the KMS key is a multi-Region primary key with replica keys, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.

Constraints:
Range: 1 - 365

Class com.amazonaws.services.kms.model.ScheduleKeyDeletionResult extends java.lang.Object implements Serializable

Serialized Fields

deletionDate

java.util.Date deletionDate

The date and time after which KMS deletes the KMS key.

If the KMS key is a multi-Region primary key with replica keys, this field does not appear. The deletion date for the primary key isn't known until its last replica key is deleted.

keyId

java.lang.String keyId

The Amazon Resource Name (key ARN) of the KMS key whose deletion is scheduled.

Constraints:
Length: 1 - 2048

keyState

java.lang.String keyState

The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

Constraints:
Allowed Values: Creating, Enabled, Disabled, PendingDeletion, PendingImport, PendingReplicaDeletion, Unavailable, Updating

pendingWindowInDays

java.lang.Integer pendingWindowInDays

The waiting period before the KMS key is deleted.

If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

Constraints:
Range: 1 - 365

Class com.amazonaws.services.kms.model.SignRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

grantTokens

java.util.List<java.lang.String> grantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

keyId

java.lang.String keyId

Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS key to sign the message. The KeyUsage type of the KMS key must be SIGN_VERIFY. To find the KeyUsage of a KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Constraints:
Length: 1 - 2048

message

java.nio.ByteBuffer message

Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.

If you provide a message, KMS generates a hash digest of the message and then signs it.

Constraints:
Length: 1 - 4096

messageType

java.lang.String messageType

Tells KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

Constraints:
Allowed Values: RAW, DIGEST

signingAlgorithm

java.lang.String signingAlgorithm

Specifies the signing algorithm to use when signing the message.

Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key.

Constraints:
Allowed Values: RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512, SM2DSA

Class com.amazonaws.services.kms.model.SignResult extends java.lang.Object implements Serializable

Serialized Fields

keyId

java.lang.String keyId

The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the message.

Constraints:
Length: 1 - 2048

signature

java.nio.ByteBuffer signature

The cryptographic signature that was generated for the message.

• When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.

• When used with the ECDSA_SHA_256, ECDSA_SHA_384 , or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANS X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.

When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Constraints:
Length: 1 - 6144

signingAlgorithm

java.lang.String signingAlgorithm

The signing algorithm that was used to sign the message.

Constraints:
Allowed Values: RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512, SM2DSA

Class com.amazonaws.services.kms.model.Tag extends java.lang.Object implements Serializable

Serialized Fields

tagKey

java.lang.String tagKey

The key of the tag.

Constraints:
Length: 1 - 128

tagValue

java.lang.String tagValue

The value of the tag.

Constraints:
Length: 0 - 256

Class com.amazonaws.services.kms.model.TagException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyId

java.lang.String keyId

Identifies a customer managed key in the account and Region.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

tags

java.util.List<Tag> tags

One or more tags.

Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string.

You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

Class com.amazonaws.services.kms.model.UnsupportedOperationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyId

java.lang.String keyId

Identifies the KMS key from which you are removing tags.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

tagKeys

java.util.List<java.lang.String> tagKeys

One or more tag keys. Specify only the tag keys, not the tag values.

Class com.amazonaws.services.kms.model.UpdateAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aliasName

java.lang.String aliasName

Identifies the alias that is changing its KMS key. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.

Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$

targetKeyId

java.lang.String targetKeyId

Identifies the customer managed key to associate with the alias. You don't have permission to associate an alias with an Amazon Web Services managed key.

The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key must be the same type as the current target KMS key (both symmetric or both asymmetric) and they must have the same key usage.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

To verify that the alias is mapped to the correct KMS key, use ListAliases.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.UpdateCustomKeyStoreRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cloudHsmClusterId

java.lang.String cloudHsmClusterId

Associates the custom key store with a related CloudHSM cluster.

Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

Constraints:
Length: 19 - 24

customKeyStoreId

java.lang.String customKeyStoreId

Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Constraints:
Length: 1 - 64

keyStorePassword

java.lang.String keyStorePassword

Enter the current password of the kmsuser crypto user (CU) in the CloudHSM cluster that is associated with the custom key store.

This parameter tells KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the CloudHSM cluster.

Constraints:
Length: 7 - 32

newCustomKeyStoreName

java.lang.String newCustomKeyStoreName

Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the Amazon Web Services account.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.kms.model.UpdateCustomKeyStoreResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.kms.model.UpdateKeyDescriptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

New description for the KMS key.

Constraints:
Length: 0 - 8192

keyId

java.lang.String keyId

Updates the description of the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

Class com.amazonaws.services.kms.model.UpdatePrimaryRegionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyId

java.lang.String keyId

Identifies the current primary key. When the operation completes, this KMS key will be a replica key.

Specify the key ID or key ARN of a multi-Region primary key.

For example:

• Key ID: mrk-1234abcd12ab34cd56ef1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Constraints:
Length: 1 - 2048

primaryRegion

java.lang.String primaryRegion

The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1 or ap-southeast-2. There must be an existing replica key in this Region.

When the operation completes, the multi-Region key in this Region will be the primary key.

Constraints:
Length: 1 - 32
Pattern: ^([a-z]+-){2,3}\d+$

Class com.amazonaws.services.kms.model.VerifyMacRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

grantTokens

java.util.List<java.lang.String> grantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

keyId

java.lang.String keyId

The KMS key that will be used in the verification.

Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key, the VerifyMac operation fails.

Constraints:
Length: 1 - 2048

mac

java.nio.ByteBuffer mac

The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.

Constraints:
Length: 1 - 6144

macAlgorithm

java.lang.String macAlgorithm

The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId parameter.

Constraints:
Allowed Values: HMAC_SHA_224, HMAC_SHA_256, HMAC_SHA_384, HMAC_SHA_512

message

java.nio.ByteBuffer message

The message that will be used in the verification. Enter the same message that was used to generate the HMAC.

GenerateMac and VerifyMac do not provide special handling for message digests. If you generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.

Constraints:
Length: 1 - 4096

Class com.amazonaws.services.kms.model.VerifyMacResult extends java.lang.Object implements Serializable

Serialized Fields

keyId

java.lang.String keyId

The HMAC KMS key used in the verification.

Constraints:
Length: 1 - 2048

macAlgorithm

java.lang.String macAlgorithm

The MAC algorithm used in the verification.

Constraints:
Allowed Values: HMAC_SHA_224, HMAC_SHA_256, HMAC_SHA_384, HMAC_SHA_512

macValid

java.lang.Boolean macValid

A Boolean value that indicates whether the HMAC was verified. A value of True indicates that the HMAC (Mac) was generated with the specified Message, HMAC KMS key ( KeyID) and MacAlgorithm..

If the HMAC is not verified, the VerifyMac operation fails with a KMSInvalidMacException exception. This exception indicates that one or more of the inputs changed since the HMAC was computed.

Class com.amazonaws.services.kms.model.VerifyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

grantTokens

java.util.List<java.lang.String> grantTokens

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

keyId

java.lang.String keyId

Identifies the asymmetric KMS key that will be used to verify the signature. This must be the same KMS key that was used to generate the signature. If you specify a different KMS key, the signature verification fails.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Constraints:
Length: 1 - 2048

message

java.nio.ByteBuffer message

Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash digest of the message. If you submit a digest, use the MessageType parameter with a value of DIGEST.

If the message specified here is different from the message that was signed, the signature verification fails. A message and its hash digest are considered to be the same message.

Constraints:
Length: 1 - 4096

messageType

java.lang.String messageType

Tells KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

Use the DIGEST value only when the value of the Message parameter is a message digest. If you use the DIGEST value with a raw message, the security of the verification operation can be compromised.

Constraints:
Allowed Values: RAW, DIGEST

signature

java.nio.ByteBuffer signature

The signature that the Sign operation generated.

Constraints:
Length: 1 - 6144

signingAlgorithm

java.lang.String signingAlgorithm

The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.

Constraints:
Allowed Values: RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512, SM2DSA

Class com.amazonaws.services.kms.model.VerifyResult extends java.lang.Object implements Serializable

Serialized Fields

keyId

java.lang.String keyId

The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to verify the signature.

Constraints:
Length: 1 - 2048

signatureValid

java.lang.Boolean signatureValid

A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.

signingAlgorithm

java.lang.String signingAlgorithm

The signing algorithm that was used to verify the signature.

Constraints:
Allowed Values: RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512, SM2DSA

Package com.amazonaws.services.lambda.model

Class com.amazonaws.services.lambda.model.EC2AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.EC2ThrottledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.EC2UnexpectedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

eC2ErrorCode

java.lang.String eC2ErrorCode

type

java.lang.String type

Class com.amazonaws.services.lambda.model.EFSIOException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.EFSMountConnectivityException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.EFSMountFailureException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.EFSMountTimeoutException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.ENILimitReachedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

The exception type.

Class com.amazonaws.services.lambda.model.InvalidRequestContentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

The exception type.

Class com.amazonaws.services.lambda.model.InvalidRuntimeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.InvalidSecurityGroupIDException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.InvalidSubnetIDException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.InvalidZipFileException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.InvokeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientContext

java.lang.String clientContext

Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

functionName

java.lang.String functionName

The name of the Lambda function, version, or alias.

Name formats

• Function name - my-function (name-only), my-function:v1 (with alias).

• Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

• Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Constraints:
Length: 1 - 170
Pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{ 1}:)?(\d{12} :)?(function:)?([a-zA-Z0-9-_\.]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?

invocationType

java.lang.String invocationType

Choose from the following options.

• RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.

• Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if it's configured). The API response only includes a status code.

• DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.

Constraints:
Allowed Values: Event, RequestResponse, DryRun

logType

java.lang.String logType

Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.

Constraints:
Allowed Values: None, Tail

payload

java.nio.ByteBuffer payload

The JSON that you want to provide to your Lambda function as input.

You can enter the JSON directly. For example, --payload '{ "key": "value" }'. You can also specify a file path. For example, --payload file://payload.json.

qualifier

java.lang.String qualifier

Specify a version or alias to invoke a published version of the function.

Constraints:
Length: 1 - 128
Pattern: (|[a-zA-Z0-9$_-]+)

Class com.amazonaws.services.lambda.model.InvokeResult extends java.lang.Object implements Serializable

Serialized Fields

executedVersion

java.lang.String executedVersion

The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.

Constraints:
Length: 1 - 1024
Pattern: (\$LATEST|[0-9]+)

functionError

java.lang.String functionError

If present, indicates that an error occurred during function execution. Details about the error are included in the response payload.

logResult

java.lang.String logResult

The last 4 KB of the execution log, which is base64 encoded.

payload

java.nio.ByteBuffer payload

The response from the function, or an error object.

statusCode

java.lang.Integer statusCode

The HTTP status code is in the 200 range for a successful request. For the RequestResponse invocation type, this status code is 200. For the Event invocation type, this status code is 202. For the DryRun invocation type, the status code is 204.

Class com.amazonaws.services.lambda.model.KMSAccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.KMSDisabledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.KMSInvalidStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.KMSNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.RequestTooLargeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.ResourceConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

The exception type.

Class com.amazonaws.services.lambda.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.ResourceNotReadyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

The exception type.

Class com.amazonaws.services.lambda.model.ServiceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.SubnetIPAddressLimitReachedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Class com.amazonaws.services.lambda.model.TooManyRequestsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

reason

java.lang.String reason

retryAfterSeconds

java.lang.String retryAfterSeconds

The number of seconds the caller should wait before retrying.

type

java.lang.String type

Class com.amazonaws.services.lambda.model.UnsupportedMediaTypeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

java.lang.String type

Package com.amazonaws.services.lexrts.model

Class com.amazonaws.services.lexrts.model.ActiveContext extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the context.

Constraints:
Length: 1 - 100
Pattern: ^([A-Za-z]_?)+$

parameters

java.util.Map<java.lang.String,java.lang.String> parameters

State variables for the current context. You can use these values as default values for slots in subsequent events.

timeToLive

ActiveContextTimeToLive timeToLive

The length of time or number of turns that a context remains active.

Class com.amazonaws.services.lexrts.model.ActiveContextTimeToLive extends java.lang.Object implements Serializable

Serialized Fields

timeToLiveInSeconds

java.lang.Integer timeToLiveInSeconds

The number of seconds that the context should be active after it is first sent in a PostContent or PostText response. You can set the value between 5 and 86,400 seconds (24 hours).

Constraints:
Range: 5 - 86400

turnsToLive

java.lang.Integer turnsToLive

The number of conversation turns that the context should be active. A conversation turn is one PostContent or PostText request and the corresponding response from Amazon Lex.

Constraints:
Range: 1 - 20

Class com.amazonaws.services.lexrts.model.BadGatewayException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.lexrts.model.BadRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.lexrts.model.Button extends java.lang.Object implements Serializable

Serialized Fields

text

java.lang.String text

Text that is visible to the user on the button.

Constraints:
Length: 1 - 15

value

java.lang.String value

The value sent to Amazon Lex when a user chooses the button. For example, consider button text "NYC." When the user chooses the button, the value sent can be "New York City."

Constraints:
Length: 1 - 1000

Class com.amazonaws.services.lexrts.model.ConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.lexrts.model.DeleteSessionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

botAlias

java.lang.String botAlias

The alias in use for the bot that contains the session data.

botName

java.lang.String botName

The name of the bot that contains the session data.

userId

java.lang.String userId

The identifier of the user associated with the session data.

Constraints:
Length: 2 - 100
Pattern: [0-9a-zA-Z._:-]+

Class com.amazonaws.services.lexrts.model.DeleteSessionResult extends java.lang.Object implements Serializable

Serialized Fields

botAlias

java.lang.String botAlias

The alias in use for the bot associated with the session data.

botName

java.lang.String botName

The name of the bot associated with the session data.

sessionId

java.lang.String sessionId

The unique identifier for the session.

userId

java.lang.String userId

The ID of the client application user.

Constraints:
Length: 2 - 100
Pattern: [0-9a-zA-Z._:-]+

Class com.amazonaws.services.lexrts.model.DependencyFailedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.lexrts.model.DialogAction extends java.lang.Object implements Serializable

Serialized Fields

fulfillmentState

java.lang.String fulfillmentState

The fulfillment state of the intent. The possible values are:

• Failed - The Lambda function associated with the intent failed to fulfill the intent.

• Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

• ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

Constraints:
Allowed Values: Fulfilled, Failed, ReadyForFulfillment

intentName

java.lang.String intentName

The name of the intent.

message

java.lang.String message

The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.

Constraints:
Length: 1 - 1024

messageFormat

java.lang.String messageFormat

• PlainText - The message contains plain UTF-8 text.

• CustomPayload - The message is a custom format for the client.

• SSML - The message contains text formatted for voice output.

• Composite - The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.

Constraints:
Allowed Values: PlainText, CustomPayload, SSML, Composite

slots

java.util.Map<java.lang.String,java.lang.String> slots

Map of the slots that have been gathered and their values.

slotToElicit

java.lang.String slotToElicit

The name of the slot that should be elicited from the user.

type

java.lang.String type

The next action that the bot should take in its interaction with the user. The possible values are:

• ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

• Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

• Delegate - The next action is determined by Amazon Lex.

• ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

• ElicitSlot - The next action is to elicit a slot value from the user.

Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Close, Delegate

Class com.amazonaws.services.lexrts.model.GenericAttachment extends java.lang.Object implements Serializable

Serialized Fields

attachmentLinkUrl

java.lang.String attachmentLinkUrl

The URL of an attachment to the response card.

Constraints:
Length: 1 - 2048

buttons

java.util.List<Button> buttons

The list of options to show to the user.

imageUrl

java.lang.String imageUrl

The URL of an image that is displayed to the user.

Constraints:
Length: 1 - 2048

subTitle

java.lang.String subTitle

The subtitle shown below the title.

Constraints:
Length: 1 - 80

title

java.lang.String title

The title of the option.

Constraints:
Length: 1 - 80

Class com.amazonaws.services.lexrts.model.GetSessionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

botAlias

java.lang.String botAlias

The alias in use for the bot that contains the session data.

botName

java.lang.String botName

The name of the bot that contains the session data.

checkpointLabelFilter

java.lang.String checkpointLabelFilter

A string used to filter the intents returned in the recentIntentSummaryView structure.

When you specify a filter, only intents with their checkpointLabel field set to that string are returned.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9-]+

userId

java.lang.String userId

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

Constraints:
Length: 2 - 100
Pattern: [0-9a-zA-Z._:-]+

Class com.amazonaws.services.lexrts.model.GetSessionResult extends java.lang.Object implements Serializable

Serialized Fields

activeContexts

java.util.List<ActiveContext> activeContexts

A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the PostContent, PostText, or PutSession operation.

You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.

dialogAction

DialogAction dialogAction

Describes the current state of the bot.

recentIntentSummaryView

java.util.List<IntentSummary> recentIntentSummaryView

An array of information about the intents used in the session. The array can contain a maximum of three summaries. If more than three intents are used in the session, the recentIntentSummaryView operation contains information about the last three intents used.

If you set the checkpointLabelFilter parameter in the request, the array contains only the intents with the specified label.

sessionAttributes

java.util.Map<java.lang.String,java.lang.String> sessionAttributes

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

sessionId

java.lang.String sessionId

A unique identifier for the session.

Class com.amazonaws.services.lexrts.model.IntentConfidence extends java.lang.Object implements Serializable

Serialized Fields

score

java.lang.Double score

A score that indicates how confident Amazon Lex is that an intent satisfies the user's intent. Ranges between 0.00 and 1.00. Higher scores indicate higher confidence.

Class com.amazonaws.services.lexrts.model.IntentSummary extends java.lang.Object implements Serializable

Serialized Fields

checkpointLabel

java.lang.String checkpointLabel

A user-defined label that identifies a particular intent. You can use this label to return to a previous intent.

Use the checkpointLabelFilter parameter of the GetSessionRequest operation to filter the intents returned by the operation to those with only the specified label.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9-]+

confirmationStatus

java.lang.String confirmationStatus

The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value to Denied. The possible values are:

• Confirmed - The user has responded "Yes" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.

• Denied - The user has responded "No" to the confirmation prompt.

• None - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.

Constraints:
Allowed Values: None, Confirmed, Denied

dialogActionType

java.lang.String dialogActionType

The next action that the bot should take in its interaction with the user. The possible values are:

• ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

• Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

• ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

• ElicitSlot - The next action is to elicit a slot value from the user.

Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Close, Delegate

fulfillmentState

java.lang.String fulfillmentState

The fulfillment state of the intent. The possible values are:

• Failed - The Lambda function associated with the intent failed to fulfill the intent.

• Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

• ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

Constraints:
Allowed Values: Fulfilled, Failed, ReadyForFulfillment

intentName

java.lang.String intentName

The name of the intent.

slots

java.util.Map<java.lang.String,java.lang.String> slots

Map of the slots that have been gathered and their values.

slotToElicit

java.lang.String slotToElicit

The next slot to elicit from the user. If there is not slot to elicit, the field is blank.

Class com.amazonaws.services.lexrts.model.InternalFailureException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.lexrts.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

retryAfterSeconds

java.lang.String retryAfterSeconds

Class com.amazonaws.services.lexrts.model.LoopDetectedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.lexrts.model.NotAcceptableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.lexrts.model.NotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.lexrts.model.PostContentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accept

java.lang.String accept

You pass this value as the Accept HTTP header.

The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP header value in the request.

• If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

• If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech (using the configuration you specified in the Accept header). For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

• If the value is audio/pcm, the speech returned is audio/pcm in 16-bit, little endian format.

• The following are the accepted values:

  • audio/mpeg

  • audio/ogg

  • audio/pcm

  • text/plain; charset=utf-8

  • audio/* (defaults to mpeg)

activeContexts

java.lang.String activeContexts

A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

botAlias

java.lang.String botAlias

Alias of the Amazon Lex bot.

botName

java.lang.String botName

Name of the Amazon Lex bot.

contentType

java.lang.String contentType

You pass this value as the Content-Type HTTP header.

Indicates the audio format or text. The header value must start with one of the following prefixes:

• PCM format, audio data must be in little-endian byte order.

  • audio/l16; rate=16000; channels=1

  • audio/x-l16; sample-rate=16000; channel-count=1

  • audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

• Opus format

  • audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4

• Text format

  • text/plain; charset=utf-8

inputStreamValue

java.io.InputStream inputStreamValue

User input in PCM or Opus audio format or text format as described in the Content-Type HTTP header.

You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.

requestAttributes

java.lang.String requestAttributes

You pass this value as the x-amz-lex-request-attributes HTTP header.

Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the requestAttributes and sessionAttributes headers is limited to 12 KB.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

sessionAttributes

java.lang.String sessionAttributes

You pass this value as the x-amz-lex-session-attributes HTTP header.

Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the sessionAttributes and requestAttributes headers is limited to 12 KB.

For more information, see Setting Session Attributes.

userId

java.lang.String userId

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

• The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

• If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

• If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

• A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

Constraints:
Length: 2 - 100
Pattern: [0-9a-zA-Z._:-]+

Class com.amazonaws.services.lexrts.model.PostContentResult extends java.lang.Object implements Serializable

Serialized Fields

activeContexts

java.lang.String activeContexts

A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the PostContent, PostText, or PutSession operation.

You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.

alternativeIntents

java.lang.String alternativeIntents

One to four alternative intents that may be applicable to the user's intent.

Each alternative includes a score that indicates how confident Amazon Lex is that the intent matches the user's intent. The intents are sorted by the confidence score.

audioStream

java.io.InputStream audioStream

The prompt (or statement) to convey to the user. This is based on the bot configuration and context. For example, if Amazon Lex did not understand the user intent, it sends the clarificationPrompt configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the confirmationPrompt. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the response.

botVersion

java.lang.String botVersion

The version of the bot that responded to the conversation. You can use this information to help determine if one version of a bot is performing better than another version.

Constraints:
Length: 1 - 64
Pattern: [0-9]+|\$LATEST

contentType

java.lang.String contentType

Content type as specified in the Accept HTTP header in the request.

dialogState

java.lang.String dialogState

Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.

• ElicitIntent - Amazon Lex wants to elicit the user's intent. Consider the following examples:

  For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialog state.

• ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.

  For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple "yes" or "no" response, a user might respond with additional information. For example, "yes, but make it a thick crust pizza" or "no, I want to order a drink." Amazon Lex can process such additional information (in these examples, update the crust type slot or change the intent from OrderPizza to OrderDrink).

• ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.

  For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.

• Fulfilled - Conveys that the Lambda function has successfully fulfilled the intent.

• ReadyForFulfillment - Conveys that the client has to fulfill the request.

• Failed - Conveys that the conversation with the user failed.

  This can happen for various reasons, including that the user does not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or if the Lambda function fails to fulfill the intent.

Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Fulfilled, ReadyForFulfillment, Failed

encodedInputTranscript

java.lang.String encodedInputTranscript

The text used to process the request.

If the input was an audio stream, the encodedInputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.

The encodedInputTranscript field is base-64 encoded. You must decode the field before you can use the value.

encodedMessage

java.lang.String encodedMessage

The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.

If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type in its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.

When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.

If the Lambda function returns a message, Amazon Lex passes it to the client in its response.

The encodedMessage field is base-64 encoded. You must decode the field before you can use the value.

Constraints:
Length: 1 - 1366

inputTranscript

java.lang.String inputTranscript

The text used to process the request.

You can use this field only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the inputTranscript field is null. You should use the encodedInputTranscript field instead.

If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.

intentName

java.lang.String intentName

Current user intent that Amazon Lex is aware of.

message

java.lang.String message

You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the message field is null. You should use the encodedMessage field instead.

The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.

If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type in its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.

When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.

If the Lambda function returns a message, Amazon Lex passes it to the client in its response.

Constraints:
Length: 1 - 1024

messageFormat

java.lang.String messageFormat

The format of the response message. One of the following values:

• PlainText - The message contains plain UTF-8 text.

• CustomPayload - The message is a custom format for the client.

• SSML - The message contains text formatted for voice output.

• Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

Constraints:
Allowed Values: PlainText, CustomPayload, SSML, Composite

nluIntentConfidence

java.lang.String nluIntentConfidence

Provides a score that indicates how confident Amazon Lex is that the returned intent is the one that matches the user's intent. The score is between 0.0 and 1.0.

The score is a relative score, not an absolute score. The score may change based on improvements to Amazon Lex.

sentimentResponse

java.lang.String sentimentResponse

The sentiment expressed in an utterance.

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

sessionAttributes

java.lang.String sessionAttributes

Map of key/value pairs representing the session-specific context information.

sessionId

java.lang.String sessionId

The unique identifier for the session.

slots

java.lang.String slots

Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation. The field is base-64 encoded.

Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE.

slotToElicit

java.lang.String slotToElicit

If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

Class com.amazonaws.services.lexrts.model.PostTextRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

activeContexts

java.util.List<ActiveContext> activeContexts

A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

botAlias

java.lang.String botAlias

The alias of the Amazon Lex bot.

botName

java.lang.String botName

The name of the Amazon Lex bot.

inputText

java.lang.String inputText

The text that the user entered (Amazon Lex interprets this text).

Constraints:
Length: 1 - 1024

requestAttributes

java.util.Map<java.lang.String,java.lang.String> requestAttributes

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

sessionAttributes

java.util.Map<java.lang.String,java.lang.String> sessionAttributes

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

userId

java.lang.String userId

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

• The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

• If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

• If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

• A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

Constraints:
Length: 2 - 100
Pattern: [0-9a-zA-Z._:-]+

Class com.amazonaws.services.lexrts.model.PostTextResult extends java.lang.Object implements Serializable

Serialized Fields

activeContexts

java.util.List<ActiveContext> activeContexts

A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the PostContent, PostText, or PutSession operation.

You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.

alternativeIntents

java.util.List<PredictedIntent> alternativeIntents

One to four alternative intents that may be applicable to the user's intent.

Each alternative includes a score that indicates how confident Amazon Lex is that the intent matches the user's intent. The intents are sorted by the confidence score.

botVersion

java.lang.String botVersion

The version of the bot that responded to the conversation. You can use this information to help determine if one version of a bot is performing better than another version.

Constraints:
Length: 1 - 64
Pattern: [0-9]+|\$LATEST

dialogState

java.lang.String dialogState

Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.

• ElicitIntent - Amazon Lex wants to elicit user intent.

  For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.

• ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.

  For example, Amazon Lex wants user confirmation before fulfilling an intent.

  Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).

• ElicitSlot - Amazon Lex is expecting a slot value for the current intent.

  For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.

• Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.

• ReadyForFulfillment - Conveys that the client has to fulfill the intent.

• Failed - Conveys that the conversation with the user failed.

  This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.

Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Fulfilled, ReadyForFulfillment, Failed

intentName

java.lang.String intentName

The current user intent that Amazon Lex is aware of.

message

java.lang.String message

The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.

If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.

When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.

If the Lambda function returns a message, Amazon Lex passes it to the client in its response.

Constraints:
Length: 1 - 1024

messageFormat

java.lang.String messageFormat

The format of the response message. One of the following values:

• PlainText - The message contains plain UTF-8 text.

• CustomPayload - The message is a custom format defined by the Lambda function.

• SSML - The message contains text formatted for voice output.

• Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

Constraints:
Allowed Values: PlainText, CustomPayload, SSML, Composite

nluIntentConfidence

IntentConfidence nluIntentConfidence

Provides a score that indicates how confident Amazon Lex is that the returned intent is the one that matches the user's intent. The score is between 0.0 and 1.0. For more information, see Confidence Scores.

The score is a relative score, not an absolute score. The score may change based on improvements to Amazon Lex.

responseCard

ResponseCard responseCard

Represents the options that the user has to respond to the current prompt. Response Card can come from the bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda function).

sentimentResponse

SentimentResponse sentimentResponse

The sentiment expressed in and utterance.

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

sessionAttributes

java.util.Map<java.lang.String,java.lang.String> sessionAttributes

A map of key-value pairs representing the session-specific context information.

sessionId

java.lang.String sessionId

A unique identifier for the session.

slots

java.util.Map<java.lang.String,java.lang.String> slots

The intent slots that Amazon Lex detected from the user input in the conversation.

Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE.

slotToElicit

java.lang.String slotToElicit

If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

Class com.amazonaws.services.lexrts.model.PredictedIntent extends java.lang.Object implements Serializable

Serialized Fields

intentName

java.lang.String intentName

The name of the intent that Amazon Lex suggests satisfies the user's intent.

nluIntentConfidence

IntentConfidence nluIntentConfidence

Indicates how confident Amazon Lex is that an intent satisfies the user's intent.

slots

java.util.Map<java.lang.String,java.lang.String> slots

The slot and slot values associated with the predicted intent.

Class com.amazonaws.services.lexrts.model.PutSessionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accept

java.lang.String accept

The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.

• If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

• If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

• If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, little endian format.

• The following are the accepted values:

  • audio/mpeg

  • audio/ogg

  • audio/pcm

  • audio/* (defaults to mpeg)

  • text/plain; charset=utf-8

activeContexts

java.util.List<ActiveContext> activeContexts

A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

botAlias

java.lang.String botAlias

The alias in use for the bot that contains the session data.

botName

java.lang.String botName

The name of the bot that contains the session data.

dialogAction

DialogAction dialogAction

Sets the next action that the bot should take to fulfill the conversation.

recentIntentSummaryView

java.util.List<IntentSummary> recentIntentSummaryView

A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

• intentName

• slot names

• slotToElict

If you send the recentIntentSummaryView parameter in a PutSession request, the contents of the new summary view replaces the old summary view. For example, if a GetSession request returns three intents in the summary view and you call PutSession with one intent in the summary view, the next call to GetSession will only return one intent.

sessionAttributes

java.util.Map<java.lang.String,java.lang.String> sessionAttributes

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

userId

java.lang.String userId

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

Constraints:
Length: 2 - 100
Pattern: [0-9a-zA-Z._:-]+

Class com.amazonaws.services.lexrts.model.PutSessionResult extends java.lang.Object implements Serializable

Serialized Fields

activeContexts

java.lang.String activeContexts

A list of active contexts for the session.

audioStream

java.io.InputStream audioStream

The audio version of the message to convey to the user.

contentType

java.lang.String contentType

Content type as specified in the Accept HTTP header in the request.

dialogState

java.lang.String dialogState

• ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before fulfilling an intent.

• ElicitIntent - Amazon Lex wants to elicit the user's intent.

• ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.

• Failed - Conveys that the conversation with the user has failed. This can happen for various reasons, including the user does not provide an appropriate response to prompts from the service, or if the Lambda function fails to fulfill the intent.

• Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.

• ReadyForFulfillment - Conveys that the client has to fulfill the intent.

Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Fulfilled, ReadyForFulfillment, Failed

encodedMessage

java.lang.String encodedMessage

The next message that should be presented to the user.

The encodedMessage field is base-64 encoded. You must decode the field before you can use the value.

Constraints:
Length: 1 - 1366

intentName

java.lang.String intentName

The name of the current intent.

message

java.lang.String message

The next message that should be presented to the user.

You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the message field is null. You should use the encodedMessage field instead.

Constraints:
Length: 1 - 1024

messageFormat

java.lang.String messageFormat

The format of the response message. One of the following values:

• PlainText - The message contains plain UTF-8 text.

• CustomPayload - The message is a custom format for the client.

• SSML - The message contains text formatted for voice output.

• Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

Constraints:
Allowed Values: PlainText, CustomPayload, SSML, Composite

sessionAttributes

java.lang.String sessionAttributes

Map of key/value pairs representing session-specific context information.

sessionId

java.lang.String sessionId

A unique identifier for the session.

slots

java.lang.String slots

Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.

Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy the default is ORIGINAL_VALUE.

slotToElicit

java.lang.String slotToElicit

If the dialogState is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

Class com.amazonaws.services.lexrts.model.RequestTimeoutException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.lexrts.model.ResponseCard extends java.lang.Object implements Serializable

Serialized Fields

contentType

java.lang.String contentType

The content type of the response.

Constraints:
Allowed Values: application/vnd.amazonaws.card.generic

genericAttachments

java.util.List<GenericAttachment> genericAttachments

An array of attachment objects representing options.

version

java.lang.String version

The version of the response card format.

Class com.amazonaws.services.lexrts.model.SentimentResponse extends java.lang.Object implements Serializable

Serialized Fields

sentimentLabel

java.lang.String sentimentLabel

The inferred sentiment that Amazon Comprehend has the highest confidence in.

sentimentScore

java.lang.String sentimentScore

The likelihood that the sentiment was correctly inferred.

Class com.amazonaws.services.lexrts.model.UnsupportedMediaTypeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.logs.model

Class com.amazonaws.services.logs.model.AssociateKmsKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

kmsKeyId

java.lang.String kmsKeyId

The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see Amazon Resource Names - AWS Key Management Service (AWS KMS).

Constraints:
Length: - 256

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Class com.amazonaws.services.logs.model.CancelExportTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskId

java.lang.String taskId

The ID of the export task.

Constraints:
Length: 1 - 512

Class com.amazonaws.services.logs.model.CreateExportTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destination

java.lang.String destination

The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.

Constraints:
Length: 1 - 512

destinationPrefix

java.lang.String destinationPrefix

The prefix used as the start of the key for every object exported. If you don't specify a value, the default is exportedlogs.

from

java.lang.Long from

The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp earlier than this time are not exported.

Constraints:
Range: 0 -

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

logStreamNamePrefix

java.lang.String logStreamNamePrefix

Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

taskName

java.lang.String taskName

The name of the export task.

Constraints:
Length: 1 - 512

to

java.lang.Long to

The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not exported.

Constraints:
Range: 0 -

Class com.amazonaws.services.logs.model.CreateExportTaskResult extends java.lang.Object implements Serializable

Serialized Fields

taskId

java.lang.String taskId

The ID of the export task.

Constraints:
Length: 1 - 512

Class com.amazonaws.services.logs.model.CreateLogGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

kmsKeyId

java.lang.String kmsKeyId

The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see Amazon Resource Names - AWS Key Management Service (AWS KMS).

Constraints:
Length: - 256

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

tags

java.util.Map<java.lang.String,java.lang.String> tags

The key-value pairs to use for the tags.

Class com.amazonaws.services.logs.model.CreateLogStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

logStreamName

java.lang.String logStreamName

The name of the log stream.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Class com.amazonaws.services.logs.model.DataAlreadyAcceptedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

expectedSequenceToken

java.lang.String expectedSequenceToken

Class com.amazonaws.services.logs.model.DeleteDestinationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationName

java.lang.String destinationName

The name of the destination.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Class com.amazonaws.services.logs.model.DeleteLogGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Class com.amazonaws.services.logs.model.DeleteLogStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

logStreamName

java.lang.String logStreamName

The name of the log stream.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Class com.amazonaws.services.logs.model.DeleteMetricFilterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filterName

java.lang.String filterName

The name of the metric filter.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Class com.amazonaws.services.logs.model.DeleteResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

java.lang.String policyName

The name of the policy to be revoked. This parameter is required.

Class com.amazonaws.services.logs.model.DeleteRetentionPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Class com.amazonaws.services.logs.model.DeleteSubscriptionFilterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filterName

java.lang.String filterName

The name of the subscription filter.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Class com.amazonaws.services.logs.model.DescribeDestinationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationNamePrefix

java.lang.String destinationNamePrefix

The prefix to match. If you don't specify a value, no prefix filter is applied.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

limit

java.lang.Integer limit

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Constraints:
Range: 1 - 50

nextToken

java.lang.String nextToken

The token for the next set of items to return. (You received this token from a previous call.)

Constraints:
Length: 1 -

Class com.amazonaws.services.logs.model.DescribeDestinationsResult extends java.lang.Object implements Serializable

Serialized Fields

destinations

java.util.List<Destination> destinations

The destinations.

nextToken

java.lang.String nextToken

The token for the next set of items to return. The token expires after 24 hours.

Constraints:
Length: 1 -

Class com.amazonaws.services.logs.model.DescribeExportTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

limit

java.lang.Integer limit

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Constraints:
Range: 1 - 50

nextToken

java.lang.String nextToken

The token for the next set of items to return. (You received this token from a previous call.)

Constraints:
Length: 1 -

statusCode

java.lang.String statusCode

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

Constraints:
Allowed Values: CANCELLED, COMPLETED, FAILED, PENDING, PENDING_CANCEL, RUNNING

taskId

java.lang.String taskId

The ID of the export task. Specifying a task ID filters the results to zero or one export tasks.

Constraints:
Length: 1 - 512

Class com.amazonaws.services.logs.model.DescribeExportTasksResult extends java.lang.Object implements Serializable

Serialized Fields

exportTasks

java.util.List<ExportTask> exportTasks

The export tasks.

nextToken

java.lang.String nextToken

The token for the next set of items to return. The token expires after 24 hours.

Constraints:
Length: 1 -

Class com.amazonaws.services.logs.model.DescribeLogGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

limit

java.lang.Integer limit

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Constraints:
Range: 1 - 50

logGroupNamePrefix

java.lang.String logGroupNamePrefix

The prefix to match.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

nextToken

java.lang.String nextToken

The token for the next set of items to return. (You received this token from a previous call.)

Constraints:
Length: 1 -

Class com.amazonaws.services.logs.model.DescribeLogGroupsResult extends java.lang.Object implements Serializable

Serialized Fields

logGroups

java.util.List<LogGroup> logGroups

The log groups.

nextToken

java.lang.String nextToken

The token for the next set of items to return. The token expires after 24 hours.

Constraints:
Length: 1 -

Class com.amazonaws.services.logs.model.DescribeLogStreamsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

descending

java.lang.Boolean descending

If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

limit

java.lang.Integer limit

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Constraints:
Range: 1 - 50

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

logStreamNamePrefix

java.lang.String logStreamNamePrefix

The prefix to match.

If orderBy is LastEventTime,you cannot specify this parameter.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

nextToken

java.lang.String nextToken

The token for the next set of items to return. (You received this token from a previous call.)

Constraints:
Length: 1 -

orderBy

java.lang.String orderBy

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

Constraints:
Allowed Values: LogStreamName, LastEventTime

Class com.amazonaws.services.logs.model.DescribeLogStreamsResult extends java.lang.Object implements Serializable

Serialized Fields

logStreams

java.util.List<LogStream> logStreams

The log streams.

nextToken

java.lang.String nextToken

The token for the next set of items to return. The token expires after 24 hours.

Constraints:
Length: 1 -

Class com.amazonaws.services.logs.model.DescribeMetricFiltersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filterNamePrefix

java.lang.String filterNamePrefix

The prefix to match.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

limit

java.lang.Integer limit

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Constraints:
Range: 1 - 50

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

metricName

java.lang.String metricName

Filters results to include only those with the specified metric name. If you include this parameter in your request, you must also include the metricNamespace parameter.

Constraints:
Length: - 255
Pattern: [^:*$]*

metricNamespace

java.lang.String metricNamespace

Filters results to include only those in the specified namespace. If you include this parameter in your request, you must also include the metricName parameter.

Constraints:
Length: - 255
Pattern: [^:*$]*

nextToken

java.lang.String nextToken

The token for the next set of items to return. (You received this token from a previous call.)

Constraints:
Length: 1 -

Class com.amazonaws.services.logs.model.DescribeMetricFiltersResult extends java.lang.Object implements Serializable

Serialized Fields

metricFilters

java.util.List<MetricFilter> metricFilters

The metric filters.

nextToken

java.lang.String nextToken

The token for the next set of items to return. The token expires after 24 hours.

Constraints:
Length: 1 -

Class com.amazonaws.services.logs.model.DescribeResourcePoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

limit

java.lang.Integer limit

The maximum number of resource policies to be displayed with one call of this API.

Constraints:
Range: 1 - 50

nextToken

java.lang.String nextToken

The token for the next set of items to return. The token expires after 24 hours.

Constraints:
Length: 1 -

Class com.amazonaws.services.logs.model.DescribeResourcePoliciesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token for the next set of items to return. The token expires after 24 hours.

Constraints:
Length: 1 -

resourcePolicies

java.util.List<ResourcePolicy> resourcePolicies

The resource policies that exist in this account.

Class com.amazonaws.services.logs.model.DescribeSubscriptionFiltersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filterNamePrefix

java.lang.String filterNamePrefix

The prefix to match. If you don't specify a value, no prefix filter is applied.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

limit

java.lang.Integer limit

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Constraints:
Range: 1 - 50

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

nextToken

java.lang.String nextToken

The token for the next set of items to return. (You received this token from a previous call.)

Constraints:
Length: 1 -

Class com.amazonaws.services.logs.model.DescribeSubscriptionFiltersResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token for the next set of items to return. The token expires after 24 hours.

Constraints:
Length: 1 -

subscriptionFilters

java.util.List<SubscriptionFilter> subscriptionFilters

The subscription filters.

Class com.amazonaws.services.logs.model.Destination extends java.lang.Object implements Serializable

Serialized Fields

accessPolicy

java.lang.String accessPolicy

An IAM policy document that governs which AWS accounts can create subscription filters against this destination.

Constraints:
Length: 1 -

arn

java.lang.String arn

The ARN of this destination.

creationTime

java.lang.Long creationTime

The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

destinationName

java.lang.String destinationName

The name of the destination.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

roleArn

java.lang.String roleArn

A role for impersonation, used when delivering log events to the target.

Constraints:
Length: 1 -

targetArn

java.lang.String targetArn

The Amazon Resource Name (ARN) of the physical target to where the log events are delivered (for example, a Kinesis stream).

Constraints:
Length: 1 -

Class com.amazonaws.services.logs.model.DisassociateKmsKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Class com.amazonaws.services.logs.model.ExportTask extends java.lang.Object implements Serializable

Serialized Fields

destination

java.lang.String destination

The name of Amazon S3 bucket to which the log data was exported.

Constraints:
Length: 1 - 512

destinationPrefix

java.lang.String destinationPrefix

The prefix that was used as the start of Amazon S3 key for every object exported.

executionInfo

ExportTaskExecutionInfo executionInfo

Execution info about the export task.

from

java.lang.Long from

The start time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp before this time are not exported.

Constraints:
Range: 0 -

logGroupName

java.lang.String logGroupName

The name of the log group from which logs data was exported.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

status

ExportTaskStatus status

The status of the export task.

taskId

java.lang.String taskId

The ID of the export task.

Constraints:
Length: 1 - 512

taskName

java.lang.String taskName

The name of the export task.

Constraints:
Length: 1 - 512

to

java.lang.Long to

The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not exported.

Constraints:
Range: 0 -

Class com.amazonaws.services.logs.model.ExportTaskExecutionInfo extends java.lang.Object implements Serializable

Serialized Fields

completionTime

java.lang.Long completionTime

The completion time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

creationTime

java.lang.Long creationTime

The creation time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

Class com.amazonaws.services.logs.model.ExportTaskStatus extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.String code

The status code of the export task.

Constraints:
Allowed Values: CANCELLED, COMPLETED, FAILED, PENDING, PENDING_CANCEL, RUNNING

message

java.lang.String message

The status message related to the status code.

Class com.amazonaws.services.logs.model.FilteredLogEvent extends java.lang.Object implements Serializable

Serialized Fields

eventId

java.lang.String eventId

The ID of the event.

ingestionTime

java.lang.Long ingestionTime

The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

logStreamName

java.lang.String logStreamName

The name of the log stream this event belongs to.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

message

java.lang.String message

The data contained in the log event.

Constraints:
Length: 1 -

timestamp

java.lang.Long timestamp

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

Class com.amazonaws.services.logs.model.FilterLogEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endTime

java.lang.Long endTime

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not returned.

Constraints:
Range: 0 -

filterPattern

java.lang.String filterPattern

The filter pattern to use. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.

Constraints:
Length: 0 - 1024

interleaved

java.lang.Boolean interleaved

If the value is true, the operation makes a best effort to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. The default is false.

limit

java.lang.Integer limit

The maximum number of events to return. The default is 10,000 events.

Constraints:
Range: 1 - 10000

logGroupName

java.lang.String logGroupName

The name of the log group to search.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

logStreamNamePrefix

java.lang.String logStreamNamePrefix

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

logStreamNames

java.util.List<java.lang.String> logStreamNames

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

nextToken

java.lang.String nextToken

The token for the next set of events to return. (You received this token from a previous call.)

Constraints:
Length: 1 -

startTime

java.lang.Long startTime

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp before this time are not returned.

Constraints:
Range: 0 -

Class com.amazonaws.services.logs.model.FilterLogEventsResult extends java.lang.Object implements Serializable

Serialized Fields

events

java.util.List<FilteredLogEvent> events

The matched events.

nextToken

java.lang.String nextToken

The token to use when requesting the next set of items. The token expires after 24 hours.

Constraints:
Length: 1 -

searchedLogStreams

java.util.List<SearchedLogStream> searchedLogStreams

Indicates which log streams have been searched and whether each has been searched completely.

Class com.amazonaws.services.logs.model.GetLogEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endTime

java.lang.Long endTime

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp equal to or later than this time are not included.

Constraints:
Range: 0 -

limit

java.lang.Integer limit

The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events.

Constraints:
Range: 1 - 10000

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

logStreamName

java.lang.String logStreamName

The name of the log stream.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

nextToken

java.lang.String nextToken

The token for the next set of items to return. (You received this token from a previous call.)

Constraints:
Length: 1 -

startFromHead

java.lang.Boolean startFromHead

If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

startTime

java.lang.Long startTime

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp equal to this time or later than this time are included. Events with a time stamp earlier than this time are not included.

Constraints:
Range: 0 -

Class com.amazonaws.services.logs.model.GetLogEventsResult extends java.lang.Object implements Serializable

Serialized Fields

events

java.util.List<OutputLogEvent> events

The events.

nextBackwardToken

java.lang.String nextBackwardToken

The token for the next set of items in the backward direction. The token expires after 24 hours. This token will never be null. If you have reached the end of the stream, it will return the same token you passed in.

Constraints:
Length: 1 -

nextForwardToken

java.lang.String nextForwardToken

The token for the next set of items in the forward direction. The token expires after 24 hours. If you have reached the end of the stream, it will return the same token you passed in.

Constraints:
Length: 1 -

Class com.amazonaws.services.logs.model.InputLogEvent extends java.lang.Object implements Serializable

Serialized Fields

message

java.lang.String message

The raw event message.

Constraints:
Length: 1 -

timestamp

java.lang.Long timestamp

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

Class com.amazonaws.services.logs.model.InvalidOperationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.logs.model.InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.logs.model.InvalidSequenceTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

expectedSequenceToken

java.lang.String expectedSequenceToken

Class com.amazonaws.services.logs.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.logs.model.ListTagsLogGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Class com.amazonaws.services.logs.model.ListTagsLogGroupResult extends java.lang.Object implements Serializable

Serialized Fields

tags

java.util.Map<java.lang.String,java.lang.String> tags

The tags for the log group.

Class com.amazonaws.services.logs.model.LogGroup extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the log group.

creationTime

java.lang.Long creationTime

The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

kmsKeyId

java.lang.String kmsKeyId

The Amazon Resource Name (ARN) of the CMK to use when encrypting log data.

Constraints:
Length: - 256

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

metricFilterCount

java.lang.Integer metricFilterCount

The number of metric filters.

retentionInDays

java.lang.Integer retentionInDays

The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.

storedBytes

java.lang.Long storedBytes

The number of bytes stored.

Constraints:
Range: 0 -

Class com.amazonaws.services.logs.model.LogStream extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the log stream.

creationTime

java.lang.Long creationTime

The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

firstEventTimestamp

java.lang.Long firstEventTimestamp

The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

lastEventTimestamp

java.lang.Long lastEventTimestamp

the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTime updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

Constraints:
Range: 0 -

lastIngestionTime

java.lang.Long lastIngestionTime

The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

logStreamName

java.lang.String logStreamName

The name of the log stream.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

storedBytes

java.lang.Long storedBytes

The number of bytes stored.

Constraints:
Range: 0 -

uploadSequenceToken

java.lang.String uploadSequenceToken

The sequence token.

Constraints:
Length: 1 -

Class com.amazonaws.services.logs.model.MetricFilter extends java.lang.Object implements Serializable

Serialized Fields

creationTime

java.lang.Long creationTime

The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

filterName

java.lang.String filterName

The name of the metric filter.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

filterPattern

java.lang.String filterPattern

A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event may contain time stamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

Constraints:
Length: 0 - 1024

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

metricTransformations

java.util.List<MetricTransformation> metricTransformations

The metric transformations.

Class com.amazonaws.services.logs.model.MetricFilterMatchRecord extends java.lang.Object implements Serializable

Serialized Fields

eventMessage

java.lang.String eventMessage

The raw event data.

Constraints:
Length: 1 -

eventNumber

java.lang.Long eventNumber

The event number.

extractedValues

java.util.Map<java.lang.String,java.lang.String> extractedValues

The values extracted from the event data by the filter.

Class com.amazonaws.services.logs.model.MetricTransformation extends java.lang.Object implements Serializable

Serialized Fields

defaultValue

java.lang.Double defaultValue

(Optional) The value to emit when a filter pattern does not match a log event. This value can be null.

metricName

java.lang.String metricName

The name of the CloudWatch metric.

Constraints:
Length: - 255
Pattern: [^:*$]*

metricNamespace

java.lang.String metricNamespace

The namespace of the CloudWatch metric.

Constraints:
Length: - 255
Pattern: [^:*$]*

metricValue

java.lang.String metricValue

The value to publish to the CloudWatch metric when a filter pattern matches a log event.

Constraints:
Length: - 100

Class com.amazonaws.services.logs.model.OperationAbortedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.logs.model.OutputLogEvent extends java.lang.Object implements Serializable

Serialized Fields

ingestionTime

java.lang.Long ingestionTime

The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

message

java.lang.String message

The data contained in the log event.

Constraints:
Length: 1 -

timestamp

java.lang.Long timestamp

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

Class com.amazonaws.services.logs.model.PutDestinationPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessPolicy

java.lang.String accessPolicy

An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination.

Constraints:
Length: 1 -

destinationName

java.lang.String destinationName

A name for an existing destination.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Class com.amazonaws.services.logs.model.PutDestinationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationName

java.lang.String destinationName

A name for the destination.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

roleArn

java.lang.String roleArn

The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.

Constraints:
Length: 1 -

targetArn

java.lang.String targetArn

The ARN of an Amazon Kinesis stream to which to deliver matching log events.

Constraints:
Length: 1 -

Class com.amazonaws.services.logs.model.PutDestinationResult extends java.lang.Object implements Serializable

Serialized Fields

destination

Destination destination

The destination.

Class com.amazonaws.services.logs.model.PutLogEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

logEvents

java.util.List<InputLogEvent> logEvents

The log events.

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

logStreamName

java.lang.String logStreamName

The name of the log stream.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

sequenceToken

java.lang.String sequenceToken

The sequence token obtained from the response of the previous PutLogEvents call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls may be successful, or one may be rejected.

Constraints:
Length: 1 -

Class com.amazonaws.services.logs.model.PutLogEventsResult extends java.lang.Object implements Serializable

Serialized Fields

nextSequenceToken

java.lang.String nextSequenceToken

The next sequence token.

Constraints:
Length: 1 -

rejectedLogEventsInfo

RejectedLogEventsInfo rejectedLogEventsInfo

The rejected events.

Class com.amazonaws.services.logs.model.PutMetricFilterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filterName

java.lang.String filterName

A name for the metric filter.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

filterPattern

java.lang.String filterPattern

A filter pattern for extracting metric data out of ingested log events.

Constraints:
Length: 0 - 1024

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

metricTransformations

java.util.List<MetricTransformation> metricTransformations

A collection of information that defines how metric data gets emitted.

Class com.amazonaws.services.logs.model.PutResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyDocument

java.lang.String policyDocument

Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string.

The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace "logArn" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.

{ "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action":"logs:PutLogEvents", "Resource": "logArn" } ] }

Constraints:
Length: 1 - 5120

policyName

java.lang.String policyName

Name of the new policy. This parameter is required.

Class com.amazonaws.services.logs.model.PutResourcePolicyResult extends java.lang.Object implements Serializable

Serialized Fields

resourcePolicy

ResourcePolicy resourcePolicy

The new policy.

Class com.amazonaws.services.logs.model.PutRetentionPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

retentionInDays

java.lang.Integer retentionInDays

The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.

Class com.amazonaws.services.logs.model.PutSubscriptionFilterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationArn

java.lang.String destinationArn

The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:

• An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.

• A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.

• An Amazon Kinesis Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.

• An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.

Constraints:
Length: 1 -

distribution

java.lang.String distribution

The method used to distribute log data to the destination. By default log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis stream.

Constraints:
Allowed Values: Random, ByLogStream

filterName

java.lang.String filterName

A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

filterPattern

java.lang.String filterPattern

A filter pattern for subscribing to a filtered stream of log events.

Constraints:
Length: 0 - 1024

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

roleArn

java.lang.String roleArn

The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.

Constraints:
Length: 1 -

Class com.amazonaws.services.logs.model.RejectedLogEventsInfo extends java.lang.Object implements Serializable

Serialized Fields

expiredLogEventEndIndex

java.lang.Integer expiredLogEventEndIndex

The expired log events.

tooNewLogEventStartIndex

java.lang.Integer tooNewLogEventStartIndex

The log events that are too new.

tooOldLogEventEndIndex

java.lang.Integer tooOldLogEventEndIndex

The log events that are too old.

Class com.amazonaws.services.logs.model.ResourceAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.logs.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.logs.model.ResourcePolicy extends java.lang.Object implements Serializable

Serialized Fields

lastUpdatedTime

java.lang.Long lastUpdatedTime

Time stamp showing when this policy was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

policyDocument

java.lang.String policyDocument

The details of the policy.

Constraints:
Length: 1 - 5120

policyName

java.lang.String policyName

The name of the resource policy.

Class com.amazonaws.services.logs.model.SearchedLogStream extends java.lang.Object implements Serializable

Serialized Fields

logStreamName

java.lang.String logStreamName

The name of the log stream.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

searchedCompletely

java.lang.Boolean searchedCompletely

Indicates whether all the events in this log stream were searched.

Class com.amazonaws.services.logs.model.ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.logs.model.SubscriptionFilter extends java.lang.Object implements Serializable

Serialized Fields

creationTime

java.lang.Long creationTime

The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

destinationArn

java.lang.String destinationArn

The Amazon Resource Name (ARN) of the destination.

Constraints:
Length: 1 -

distribution

java.lang.String distribution

The method used to distribute log data to the destination, which can be either random or grouped by log stream.

Constraints:
Allowed Values: Random, ByLogStream

filterName

java.lang.String filterName

The name of the subscription filter.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

filterPattern

java.lang.String filterPattern

A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event may contain time stamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

Constraints:
Length: 0 - 1024

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

roleArn

java.lang.String roleArn

Constraints:
Length: 1 -

Class com.amazonaws.services.logs.model.TagLogGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

tags

java.util.Map<java.lang.String,java.lang.String> tags

The key-value pairs to use for the tags.

Class com.amazonaws.services.logs.model.TestMetricFilterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filterPattern

java.lang.String filterPattern

A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event may contain time stamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

Constraints:
Length: 0 - 1024

logEventMessages

java.util.List<java.lang.String> logEventMessages

The log event messages to test.

Class com.amazonaws.services.logs.model.TestMetricFilterResult extends java.lang.Object implements Serializable

Serialized Fields

matches

java.util.List<MetricFilterMatchRecord> matches

The matched events.

Class com.amazonaws.services.logs.model.UnrecognizedClientException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.logs.model.UntagLogGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

logGroupName

java.lang.String logGroupName

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

tags

java.util.List<java.lang.String> tags

The tag keys. The corresponding tags are removed from the log group.

Package com.amazonaws.services.machinelearning.model

Class com.amazonaws.services.machinelearning.model.GetMLModelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

mLModelId

java.lang.String mLModelId

The ID assigned to the MLModel at creation.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+

verbose

java.lang.Boolean verbose

Specifies whether the GetMLModel operation should return Recipe.

If true, Recipe is returned.

If false, Recipe is not returned.

Class com.amazonaws.services.machinelearning.model.GetMLModelResult extends java.lang.Object implements Serializable

Serialized Fields

computeTime

java.lang.Long computeTime

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the MLModel, normalized and scaled on computation resources. ComputeTime is only available if the MLModel is in the COMPLETED state.

createdAt

java.util.Date createdAt

The time that the MLModel was created. The time is expressed in epoch time.

createdByIamUser

java.lang.String createdByIamUser

The AWS user account from which the MLModel was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

Constraints:
Pattern: arn:aws:iam::[0-9]+:((user/.+)|(root))

endpointInfo

RealtimeEndpointInfo endpointInfo

The current endpoint of the MLModel

finishedAt

java.util.Date finishedAt

The epoch time when Amazon Machine Learning marked the MLModel as COMPLETED or FAILED. FinishedAt is only available when the MLModel is in the COMPLETED or FAILED state.

inputDataLocationS3

java.lang.String inputDataLocationS3

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

Constraints:
Length: - 2048
Pattern: s3://([^/]+)(/.*)?

lastUpdatedAt

java.util.Date lastUpdatedAt

The time of the most recent edit to the MLModel. The time is expressed in epoch time.

logUri

java.lang.String logUri

A link to the file that contains logs of the CreateMLModel operation.

message

java.lang.String message

A description of the most recent details about accessing the MLModel.

Constraints:
Length: - 10240

mLModelId

java.lang.String mLModelId

The MLModel ID, which is same as the MLModelId in the request.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+

mLModelType

java.lang.String mLModelType

Identifies the MLModel category. The following are the available types:

• REGRESSION -- Produces a numeric result. For example, "What price should a house be listed at?"

• BINARY -- Produces one of two possible results. For example, "Is this an e-commerce website?"

• MULTICLASS -- Produces one of several possible results. For example, "Is this a HIGH, LOW or MEDIUM risk trade?"

Constraints:
Allowed Values: REGRESSION, BINARY, MULTICLASS

name

java.lang.String name

A user-supplied name or description of the MLModel.

Constraints:
Length: - 1024

recipe

java.lang.String recipe

The recipe to use when training the MLModel. The Recipe provides detailed information about the observation data to use during training, and manipulations to perform on the observation data during training.

Note: This parameter is provided as part of the verbose format.

Constraints:
Length: - 131071

schema

java.lang.String schema

The schema used by all of the data files referenced by the DataSource.

Note: This parameter is provided as part of the verbose format.

Constraints:
Length: - 131071

scoreThreshold

java.lang.Float scoreThreshold

The scoring threshold is used in binary classification MLModel models. It marks the boundary between a positive prediction and a negative prediction.

Output values greater than or equal to the threshold receive a positive result from the MLModel, such as true. Output values less than the threshold receive a negative response from the MLModel, such as false.

scoreThresholdLastUpdatedAt

java.util.Date scoreThresholdLastUpdatedAt

The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time.

sizeInBytes

java.lang.Long sizeInBytes

Long integer type that is a 64-bit signed number.

startedAt

java.util.Date startedAt

The epoch time when Amazon Machine Learning marked the MLModel as INPROGRESS. StartedAt isn't available if the MLModel is in the PENDING state.

status

java.lang.String status

The current status of the MLModel. This element can have one of the following values:

• PENDING - Amazon Machine Learning (Amazon ML) submitted a request to describe a MLModel.

• INPROGRESS - The request is processing.

• FAILED - The request did not run to completion. The ML model isn't usable.

• COMPLETED - The request completed successfully.

• DELETED - The MLModel is marked as deleted. It isn't usable.

Constraints:
Allowed Values: PENDING, INPROGRESS, FAILED, COMPLETED, DELETED

trainingDataSourceId

java.lang.String trainingDataSourceId

The ID of the training DataSource.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+

trainingParameters

java.util.Map<java.lang.String,java.lang.String> trainingParameters

A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.

The following is the current set of training parameters:

• sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.

  The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.

• sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000 . The default value is 10.

• sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none. We strongly recommend that you shuffle your data.

• sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in a sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.

  The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.

• sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.

  The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.

Class com.amazonaws.services.machinelearning.model.InternalServerException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

java.lang.Integer code

Class com.amazonaws.services.machinelearning.model.InvalidInputException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

java.lang.Integer code

Class com.amazonaws.services.machinelearning.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

java.lang.Integer code

Class com.amazonaws.services.machinelearning.model.Prediction extends java.lang.Object implements Serializable

Serialized Fields

details

java.util.Map<java.lang.String,java.lang.String> details

Provides any additional details regarding the prediction.

predictedLabel

java.lang.String predictedLabel

The prediction label for either a BINARY or MULTICLASS MLModel.

Constraints:
Length: 1 -

predictedScores

java.util.Map<java.lang.String,java.lang.Float> predictedScores

Provides the raw classification score corresponding to each label.

predictedValue

java.lang.Float predictedValue

The prediction value for REGRESSION MLModel.

Class com.amazonaws.services.machinelearning.model.PredictorNotMountedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.machinelearning.model.PredictRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

mLModelId

java.lang.String mLModelId

A unique identifier of the MLModel.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+

predictEndpoint

java.lang.String predictEndpoint

The new value for the predictEndpoint property for this object.

Constraints:
Length: - 2048
Pattern: https://[a-zA-Z0-9-.]*\.amazon(aws)?\.com[/]?

record

java.util.Map<java.lang.String,java.lang.String> record

A map of variable name-value pairs that represent an observation.

Class com.amazonaws.services.machinelearning.model.PredictResult extends java.lang.Object implements Serializable

Serialized Fields

prediction

Prediction prediction

The output from a Predict operation:

• Details - Contains the following attributes: DetailsAttributes.PREDICTIVE_MODEL_TYPE - REGRESSION | BINARY | MULTICLASS DetailsAttributes.ALGORITHM - SGD

• PredictedLabel - Present for either a BINARY or MULTICLASS MLModel request.

• PredictedScores - Contains the raw classification score corresponding to each label.

• PredictedValue - Present for a REGRESSION MLModel request.

Class com.amazonaws.services.machinelearning.model.RealtimeEndpointInfo extends java.lang.Object implements Serializable

Serialized Fields

createdAt

java.util.Date createdAt

The time that the request to create the real-time endpoint for the MLModel was received. The time is expressed in epoch time.

endpointStatus

java.lang.String endpointStatus

The current status of the real-time endpoint for the MLModel . This element can have one of the following values:

• NONE - Endpoint does not exist or was previously deleted.

• READY - Endpoint is ready to be used for real-time predictions.

• UPDATING - Updating/creating the endpoint.

Constraints:
Allowed Values: NONE, READY, UPDATING, FAILED

endpointUrl

java.lang.String endpointUrl

The URI that specifies where to send real-time prediction requests for the MLModel.

Note: The application must wait until the real-time endpoint is ready before using this URI.

Constraints:
Length: - 2048
Pattern: https://[a-zA-Z0-9-.]*\.amazon(aws)?\.com[/]?

peakRequestsPerSecond

java.lang.Integer peakRequestsPerSecond

The maximum processing rate for the real-time endpoint for MLModel, measured in incoming requests per second.

Class com.amazonaws.services.machinelearning.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

java.lang.Integer code

Package com.amazonaws.services.pinpoint.model

Class com.amazonaws.services.pinpoint.model.ActivitiesResponse extends java.lang.Object implements Serializable

Serialized Fields

item

java.util.List<ActivityResponse> item

List of campaign activities

nextToken

java.lang.String nextToken

The string that you use in a subsequent request to get the next page of results in a paginated response.

Class com.amazonaws.services.pinpoint.model.ActivityResponse extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The ID of the application to which the campaign applies.

campaignId

java.lang.String campaignId

The ID of the campaign to which the activity applies.

end

java.lang.String end

The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format.

id

java.lang.String id

The unique activity ID.

result

java.lang.String result

Indicates whether the activity succeeded. Valid values: SUCCESS, FAIL

scheduledStart

java.lang.String scheduledStart

The scheduled start time for the activity in ISO 8601 format.

start

java.lang.String start

The actual start time of the activity in ISO 8601 format.

state

java.lang.String state

The state of the activity. Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED

successfulEndpointCount

java.lang.Integer successfulEndpointCount

The total number of endpoints to which the campaign successfully delivered messages.

timezonesCompletedCount

java.lang.Integer timezonesCompletedCount

The total number of timezones completed.

timezonesTotalCount

java.lang.Integer timezonesTotalCount

The total number of unique timezones present in the segment.

totalEndpointCount

java.lang.Integer totalEndpointCount

The total number of endpoints to which the campaign attempts to deliver messages.

treatmentId

java.lang.String treatmentId

The ID of a variation of the campaign used for A/B testing.

Class com.amazonaws.services.pinpoint.model.AddressConfiguration extends java.lang.Object implements Serializable

Serialized Fields

bodyOverride

java.lang.String bodyOverride

Body override. If specified will override default body.

channelType

java.lang.String channelType

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

Constraints:
Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM

context

java.util.Map<java.lang.String,java.lang.String> context

A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.

rawContent

java.lang.String rawContent

The Raw JSON formatted string to be used as the payload. This value overrides the message.

substitutions

java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions

A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.

titleOverride

java.lang.String titleOverride

Title override. If specified will override default title if applicable.

Class com.amazonaws.services.pinpoint.model.ADMChannelRequest extends java.lang.Object implements Serializable

Serialized Fields

clientId

java.lang.String clientId

The Client ID that you obtained from the Amazon App Distribution Portal.

clientSecret

java.lang.String clientSecret

The Client Secret that you obtained from the Amazon App Distribution Portal.

enabled

java.lang.Boolean enabled

Indicates whether or not the channel is enabled for sending messages.

Class com.amazonaws.services.pinpoint.model.ADMChannelResponse extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The ID of the application to which the channel applies.

creationDate

java.lang.String creationDate

The date and time when this channel was created.

enabled

java.lang.Boolean enabled

Indicates whether or not the channel is enabled for sending messages.

hasCredential

java.lang.Boolean hasCredential

Not used. Retained for backwards compatibility.

id

java.lang.String id

(Deprecated) An identifier for the channel. Retained for backwards compatibility.

isArchived

java.lang.Boolean isArchived

Indicates whether or not the channel is archived.

lastModifiedBy

java.lang.String lastModifiedBy

The user who last updated this channel.

lastModifiedDate

java.lang.String lastModifiedDate

The date and time when this channel was last modified.

platform

java.lang.String platform

The platform type. For this channel, the value is always "ADM."

version

java.lang.Integer version

The channel version.

Class com.amazonaws.services.pinpoint.model.ADMMessage extends java.lang.Object implements Serializable

Serialized Fields

action

java.lang.String action

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

Constraints:
Allowed Values: OPEN_APP, DEEP_LINK, URL

body

java.lang.String body

The message body of the notification.

consolidationKey

java.lang.String consolidationKey

Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one.

data

java.util.Map<java.lang.String,java.lang.String> data

The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object

expiresAfter

java.lang.String expiresAfter

Optional. Number of seconds ADM should retain the message if the device is offline

iconReference

java.lang.String iconReference

The icon image name of the asset saved in your application.

imageIconUrl

java.lang.String imageIconUrl

The URL that points to an image used as the large icon to the notification content view.

imageUrl

java.lang.String imageUrl

The URL that points to an image used in the push notification.

mD5

java.lang.String mD5

Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity

rawContent

java.lang.String rawContent

The Raw JSON formatted string to be used as the payload. This value overrides the message.

silentPush

java.lang.Boolean silentPush

Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

smallImageIconUrl

java.lang.String smallImageIconUrl

The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view

sound

java.lang.String sound

Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/

substitutions

java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions

Default message substitutions. Can be overridden by individual address substitutions.

title

java.lang.String title

The message title that displays above the message on the user's device.

url

java.lang.String url

The URL to open in the user's mobile browser. Used if the value for Action is URL.

Class com.amazonaws.services.pinpoint.model.APNSChannelRequest extends java.lang.Object implements Serializable

Serialized Fields

bundleId

java.lang.String bundleId

The bundle id used for APNs Tokens.

certificate

java.lang.String certificate

The distribution certificate from Apple.

defaultAuthenticationMethod

java.lang.String defaultAuthenticationMethod

The default authentication method used for APNs.

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

privateKey

java.lang.String privateKey

The certificate private key.

teamId

java.lang.String teamId

The team id used for APNs Tokens.

tokenKey

java.lang.String tokenKey

The token key used for APNs Tokens.

tokenKeyId

java.lang.String tokenKeyId

The token key used for APNs Tokens.

Class com.amazonaws.services.pinpoint.model.APNSChannelResponse extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The ID of the application that the channel applies to.

creationDate

java.lang.String creationDate

The date and time when this channel was created.

defaultAuthenticationMethod

java.lang.String defaultAuthenticationMethod

The default authentication method used for APNs.

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

hasCredential

java.lang.Boolean hasCredential

Not used. Retained for backwards compatibility.

hasTokenKey

java.lang.Boolean hasTokenKey

Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.

id

java.lang.String id

(Deprecated) An identifier for the channel. Retained for backwards compatibility.

isArchived

java.lang.Boolean isArchived

Indicates whether or not the channel is archived.

lastModifiedBy

java.lang.String lastModifiedBy

The user who last updated this channel.

lastModifiedDate

java.lang.String lastModifiedDate

The date and time when this channel was last modified.

platform

java.lang.String platform

The platform type. For this channel, the value is always "ADM."

version

java.lang.Integer version

The channel version.

Class com.amazonaws.services.pinpoint.model.APNSMessage extends java.lang.Object implements Serializable

Serialized Fields

action

java.lang.String action

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

Constraints:
Allowed Values: OPEN_APP, DEEP_LINK, URL

badge

java.lang.Integer badge

Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.

body

java.lang.String body

The message body of the notification.

category

java.lang.String category

Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.

collapseId

java.lang.String collapseId

An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.

data

java.util.Map<java.lang.String,java.lang.String> data

The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object

mediaUrl

java.lang.String mediaUrl

A URL that refers to the location of an image or video that you want to display in the push notification.

preferredAuthenticationMethod

java.lang.String preferredAuthenticationMethod

The preferred authentication method, either "CERTIFICATE" or "TOKEN"

priority

java.lang.String priority

The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: "5" - Low priority. Messages might be delayed, delivered in groups, and throttled. "10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. The default value is "10". The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.

rawContent

java.lang.String rawContent

The Raw JSON formatted string to be used as the payload. This value overrides the message.

silentPush

java.lang.Boolean silentPush

Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

sound

java.lang.String sound

Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.

substitutions

java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions

Default message substitutions. Can be overridden by individual address substitutions.

threadId

java.lang.String threadId

Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.

timeToLive

java.lang.Integer timeToLive

The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.

title

java.lang.String title

The message title that displays above the message on the user's device.

url

java.lang.String url

The URL to open in the user's mobile browser. Used if the value for Action is URL.

Class com.amazonaws.services.pinpoint.model.APNSSandboxChannelRequest extends java.lang.Object implements Serializable

Serialized Fields

bundleId

java.lang.String bundleId

The bundle id used for APNs Tokens.

certificate

java.lang.String certificate

The distribution certificate from Apple.

defaultAuthenticationMethod

java.lang.String defaultAuthenticationMethod

The default authentication method used for APNs.

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

privateKey

java.lang.String privateKey

The certificate private key.

teamId

java.lang.String teamId

The team id used for APNs Tokens.

tokenKey

java.lang.String tokenKey

The token key used for APNs Tokens.

tokenKeyId

java.lang.String tokenKeyId

The token key used for APNs Tokens.

Class com.amazonaws.services.pinpoint.model.APNSSandboxChannelResponse extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The ID of the application to which the channel applies.

creationDate

java.lang.String creationDate

When was this segment created

defaultAuthenticationMethod

java.lang.String defaultAuthenticationMethod

The default authentication method used for APNs.

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

hasCredential

java.lang.Boolean hasCredential

Not used. Retained for backwards compatibility.

hasTokenKey

java.lang.Boolean hasTokenKey

Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.

id

java.lang.String id

Channel ID. Not used, only for backwards compatibility.

isArchived

java.lang.Boolean isArchived

Is this channel archived

lastModifiedBy

java.lang.String lastModifiedBy

Who last updated this entry

lastModifiedDate

java.lang.String lastModifiedDate

Last date this was updated

platform

java.lang.String platform

The platform type. Will be APNS_SANDBOX.

version

java.lang.Integer version

Version of channel

Class com.amazonaws.services.pinpoint.model.APNSVoipChannelRequest extends java.lang.Object implements Serializable

Serialized Fields

bundleId

java.lang.String bundleId

The bundle id used for APNs Tokens.

certificate

java.lang.String certificate

The distribution certificate from Apple.

defaultAuthenticationMethod

java.lang.String defaultAuthenticationMethod

The default authentication method used for APNs.

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

privateKey

java.lang.String privateKey

The certificate private key.

teamId

java.lang.String teamId

The team id used for APNs Tokens.

tokenKey

java.lang.String tokenKey

The token key used for APNs Tokens.

tokenKeyId

java.lang.String tokenKeyId

The token key used for APNs Tokens.

Class com.amazonaws.services.pinpoint.model.APNSVoipChannelResponse extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

Application id

creationDate

java.lang.String creationDate

When was this segment created

defaultAuthenticationMethod

java.lang.String defaultAuthenticationMethod

The default authentication method used for APNs.

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

hasCredential

java.lang.Boolean hasCredential

Not used. Retained for backwards compatibility.

hasTokenKey

java.lang.Boolean hasTokenKey

If the channel is registered with a token key for authentication.

id

java.lang.String id

Channel ID. Not used, only for backwards compatibility.

isArchived

java.lang.Boolean isArchived

Is this channel archived

lastModifiedBy

java.lang.String lastModifiedBy

Who made the last change

lastModifiedDate

java.lang.String lastModifiedDate

Last date this was updated

platform

java.lang.String platform

The platform type. Will be APNS.

version

java.lang.Integer version

Version of channel

Class com.amazonaws.services.pinpoint.model.APNSVoipSandboxChannelRequest extends java.lang.Object implements Serializable

Serialized Fields

bundleId

java.lang.String bundleId

The bundle id used for APNs Tokens.

certificate

java.lang.String certificate

The distribution certificate from Apple.

defaultAuthenticationMethod

java.lang.String defaultAuthenticationMethod

The default authentication method used for APNs.

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

privateKey

java.lang.String privateKey

The certificate private key.

teamId

java.lang.String teamId

The team id used for APNs Tokens.

tokenKey

java.lang.String tokenKey

The token key used for APNs Tokens.

tokenKeyId

java.lang.String tokenKeyId

The token key used for APNs Tokens.

Class com.amazonaws.services.pinpoint.model.APNSVoipSandboxChannelResponse extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

Application id

creationDate

java.lang.String creationDate

When was this segment created

defaultAuthenticationMethod

java.lang.String defaultAuthenticationMethod

The default authentication method used for APNs.

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

hasCredential

java.lang.Boolean hasCredential

Not used. Retained for backwards compatibility.

hasTokenKey

java.lang.Boolean hasTokenKey

If the channel is registered with a token key for authentication.

id

java.lang.String id

Channel ID. Not used, only for backwards compatibility.

isArchived

java.lang.Boolean isArchived

Is this channel archived

lastModifiedBy

java.lang.String lastModifiedBy

Who made the last change

lastModifiedDate

java.lang.String lastModifiedDate

Last date this was updated

platform

java.lang.String platform

The platform type. Will be APNS.

version

java.lang.Integer version

Version of channel

Class com.amazonaws.services.pinpoint.model.ApplicationResponse extends java.lang.Object implements Serializable

Serialized Fields

id

java.lang.String id

The unique application ID.

name

java.lang.String name

The display name of the application.

Class com.amazonaws.services.pinpoint.model.ApplicationSettingsResource extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID for the application.

campaignHook

CampaignHook campaignHook

Default campaign hook.

lastModifiedDate

java.lang.String lastModifiedDate

The date that the settings were last updated in ISO 8601 format.

limits

CampaignLimits limits

The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.

quietTime

QuietTime quietTime

The default quiet time for the app. Campaigns in the app don't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your app. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up an app to use quiet time, campaigns in that app don't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the app (or campaign, if applicable). - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the app (or campaign, if applicable). Individual campaigns within the app can have their own quiet time settings, which override the quiet time settings at the app level.

Class com.amazonaws.services.pinpoint.model.ApplicationsResponse extends java.lang.Object implements Serializable

Serialized Fields

item

java.util.List<ApplicationResponse> item

List of applications returned in this page.

nextToken

java.lang.String nextToken

The string that you use in a subsequent request to get the next page of results in a paginated response.

Class com.amazonaws.services.pinpoint.model.AttributeDimension extends java.lang.Object implements Serializable

Serialized Fields

attributeType

java.lang.String attributeType

The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.

Constraints:
Allowed Values: INCLUSIVE, EXCLUSIVE

values

java.util.List<java.lang.String> values

The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.

Class com.amazonaws.services.pinpoint.model.AttributesResource extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID for the application.

attributes

java.util.List<java.lang.String> attributes

The attributes for the application.

attributeType

java.lang.String attributeType

The attribute type for the application.

Class com.amazonaws.services.pinpoint.model.BadRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestID

java.lang.String requestID

The unique message body ID.

Class com.amazonaws.services.pinpoint.model.BaiduChannelRequest extends java.lang.Object implements Serializable

Serialized Fields

apiKey

java.lang.String apiKey

Platform credential API key from Baidu.

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

secretKey

java.lang.String secretKey

Platform credential Secret key from Baidu.

Class com.amazonaws.services.pinpoint.model.BaiduChannelResponse extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

Application id

creationDate

java.lang.String creationDate

When was this segment created

credential

java.lang.String credential

The Baidu API key from Baidu.

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

hasCredential

java.lang.Boolean hasCredential

Not used. Retained for backwards compatibility.

id

java.lang.String id

Channel ID. Not used, only for backwards compatibility.

isArchived

java.lang.Boolean isArchived

Is this channel archived

lastModifiedBy

java.lang.String lastModifiedBy

Who made the last change

lastModifiedDate

java.lang.String lastModifiedDate

Last date this was updated

platform

java.lang.String platform

The platform type. Will be BAIDU

version

java.lang.Integer version

Version of channel

Class com.amazonaws.services.pinpoint.model.BaiduMessage extends java.lang.Object implements Serializable

Serialized Fields

action

java.lang.String action

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

Constraints:
Allowed Values: OPEN_APP, DEEP_LINK, URL

body

java.lang.String body

The message body of the notification.

data

java.util.Map<java.lang.String,java.lang.String> data

The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object

iconReference

java.lang.String iconReference

The icon image name of the asset saved in your application.

imageIconUrl

java.lang.String imageIconUrl

The URL that points to an image used as the large icon to the notification content view.

imageUrl

java.lang.String imageUrl

The URL that points to an image used in the push notification.

rawContent

java.lang.String rawContent

The Raw JSON formatted string to be used as the payload. This value overrides the message.

silentPush

java.lang.Boolean silentPush

Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

smallImageIconUrl

java.lang.String smallImageIconUrl

The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view

sound

java.lang.String sound

Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/

substitutions

java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions

Default message substitutions. Can be overridden by individual address substitutions.

timeToLive

java.lang.Integer timeToLive

This parameter specifies how long (in seconds) the message should be kept in Baidu storage if the device is offline. The and the default value and the maximum time to live supported is 7 days (604800 seconds)

title

java.lang.String title

The message title that displays above the message on the user's device.

url

java.lang.String url

The URL to open in the user's mobile browser. Used if the value for Action is URL.

Class com.amazonaws.services.pinpoint.model.CampaignEmailMessage extends java.lang.Object implements Serializable

Serialized Fields

body

java.lang.String body

The email text body.

fromAddress

java.lang.String fromAddress

The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.

htmlBody

java.lang.String htmlBody

The email html body.

title

java.lang.String title

The email title (Or subject).

Class com.amazonaws.services.pinpoint.model.CampaignEventFilter extends java.lang.Object implements Serializable

Serialized Fields

dimensions

EventDimensions dimensions

An object that defines the dimensions for the event filter.

filterType

java.lang.String filterType

The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.

Constraints:
Allowed Values: SYSTEM, ENDPOINT

Class com.amazonaws.services.pinpoint.model.CampaignHook extends java.lang.Object implements Serializable

Serialized Fields

lambdaFunctionName

java.lang.String lambdaFunctionName

Lambda function name or arn to be called for delivery

mode

java.lang.String mode

What mode Lambda should be invoked in.

Constraints:
Allowed Values: DELIVERY, FILTER

webUrl

java.lang.String webUrl

Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request

Class com.amazonaws.services.pinpoint.model.CampaignLimits extends java.lang.Object implements Serializable

Serialized Fields

daily

java.lang.Integer daily

The maximum number of messages that each campaign can send to a single endpoint in a 24-hour period.

maximumDuration

java.lang.Integer maximumDuration

The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.

messagesPerSecond

java.lang.Integer messagesPerSecond

The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.

total

java.lang.Integer total

The maximum number of messages that an individual campaign can send to a single endpoint over the course of the campaign.

Class com.amazonaws.services.pinpoint.model.CampaignResponse extends java.lang.Object implements Serializable

Serialized Fields

additionalTreatments

java.util.List<TreatmentResource> additionalTreatments

Treatments that are defined in addition to the default treatment.

applicationId

java.lang.String applicationId

The ID of the application to which the campaign applies.

creationDate

java.lang.String creationDate

The date the campaign was created in ISO 8601 format.

defaultState

CampaignState defaultState

The status of the campaign's default treatment. Only present for A/B test campaigns.

description

java.lang.String description

A description of the campaign.

holdoutPercent

java.lang.Integer holdoutPercent

The allocated percentage of end users who will not receive messages from this campaign.

hook

CampaignHook hook

Campaign hook information.

id

java.lang.String id

The unique campaign ID.

isPaused

java.lang.Boolean isPaused

Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.

lastModifiedDate

java.lang.String lastModifiedDate

The date the campaign was last updated in ISO 8601 format.

limits

CampaignLimits limits

The campaign limits settings.

messageConfiguration

MessageConfiguration messageConfiguration

The message configuration settings.

name

java.lang.String name

The custom name of the campaign.

schedule

Schedule schedule

The campaign schedule.

segmentId

java.lang.String segmentId

The ID of the segment to which the campaign sends messages.

segmentVersion

java.lang.Integer segmentVersion

The version of the segment to which the campaign sends messages.

state

CampaignState state

The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.

treatmentDescription

java.lang.String treatmentDescription

A custom description for the treatment.

treatmentName

java.lang.String treatmentName

The custom name of a variation of the campaign used for A/B testing.

version

java.lang.Integer version

The campaign version number.

Class com.amazonaws.services.pinpoint.model.CampaignSmsMessage extends java.lang.Object implements Serializable

Serialized Fields

body

java.lang.String body

The SMS text body.

messageType

java.lang.String messageType

Is this is a transactional SMS message, otherwise a promotional message.

Constraints:
Allowed Values: TRANSACTIONAL, PROMOTIONAL

senderId

java.lang.String senderId

Sender ID of sent message.

Class com.amazonaws.services.pinpoint.model.CampaignsResponse extends java.lang.Object implements Serializable

Serialized Fields

item

java.util.List<CampaignResponse> item

A list of campaigns.

nextToken

java.lang.String nextToken

The string that you use in a subsequent request to get the next page of results in a paginated response.

Class com.amazonaws.services.pinpoint.model.CampaignState extends java.lang.Object implements Serializable

Serialized Fields

campaignStatus

java.lang.String campaignStatus

The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED

Constraints:
Allowed Values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED, DELETED

Class com.amazonaws.services.pinpoint.model.ChannelResponse extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

Application id

creationDate

java.lang.String creationDate

When was this segment created

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

hasCredential

java.lang.Boolean hasCredential

Not used. Retained for backwards compatibility.

id

java.lang.String id

Channel ID. Not used, only for backwards compatibility.

isArchived

java.lang.Boolean isArchived

Is this channel archived

lastModifiedBy

java.lang.String lastModifiedBy

Who made the last change

lastModifiedDate

java.lang.String lastModifiedDate

Last date this was updated

version

java.lang.Integer version

Version of channel

Class com.amazonaws.services.pinpoint.model.ChannelsResponse extends java.lang.Object implements Serializable

Serialized Fields

channels

java.util.Map<java.lang.String,ChannelResponse> channels

A map of channels, with the ChannelType as the key and the Channel as the value.

Class com.amazonaws.services.pinpoint.model.CreateApplicationRequest extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The display name of the application. Used in the Amazon Pinpoint console.

Class com.amazonaws.services.pinpoint.model.CreateAppRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

createApplicationRequest

CreateApplicationRequest createApplicationRequest

Application Request.

Class com.amazonaws.services.pinpoint.model.CreateAppResult extends java.lang.Object implements Serializable

Serialized Fields

applicationResponse

ApplicationResponse applicationResponse

Application Response.

Class com.amazonaws.services.pinpoint.model.CreateCampaignRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

writeCampaignRequest

WriteCampaignRequest writeCampaignRequest

Used to create a campaign.

Class com.amazonaws.services.pinpoint.model.CreateCampaignResult extends java.lang.Object implements Serializable

Serialized Fields

campaignResponse

CampaignResponse campaignResponse

Campaign definition

Class com.amazonaws.services.pinpoint.model.CreateExportJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

exportJobRequest

ExportJobRequest exportJobRequest

Export job request.

Class com.amazonaws.services.pinpoint.model.CreateExportJobResult extends java.lang.Object implements Serializable

Serialized Fields

exportJobResponse

ExportJobResponse exportJobResponse

Export job response.

Class com.amazonaws.services.pinpoint.model.CreateImportJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

importJobRequest

ImportJobRequest importJobRequest

Import job request.

Class com.amazonaws.services.pinpoint.model.CreateImportJobResult extends java.lang.Object implements Serializable

Serialized Fields

importJobResponse

ImportJobResponse importJobResponse

Import job response.

Class com.amazonaws.services.pinpoint.model.CreateSegmentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

writeSegmentRequest

WriteSegmentRequest writeSegmentRequest

Segment definition.

Class com.amazonaws.services.pinpoint.model.CreateSegmentResult extends java.lang.Object implements Serializable

Serialized Fields

segmentResponse

SegmentResponse segmentResponse

Segment definition.

Class com.amazonaws.services.pinpoint.model.DefaultMessage extends java.lang.Object implements Serializable

Serialized Fields

body

java.lang.String body

The message body of the notification, the email body or the text message.

substitutions

java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions

Default message substitutions. Can be overridden by individual address substitutions.

Class com.amazonaws.services.pinpoint.model.DefaultPushNotificationMessage extends java.lang.Object implements Serializable

Serialized Fields

action

java.lang.String action

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

Constraints:
Allowed Values: OPEN_APP, DEEP_LINK, URL

body

java.lang.String body

The message body of the notification.

data

java.util.Map<java.lang.String,java.lang.String> data

The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object

silentPush

java.lang.Boolean silentPush

Indicates if the message should display on the recipient's device. You can use silent pushes for remote configuration or to deliver messages to in-app notification centers.

substitutions

java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions

Default message substitutions. Can be overridden by individual address substitutions.

title

java.lang.String title

The message title that displays above the message on the user's device.

url

java.lang.String url

The URL to open in the user's mobile browser. Used if the value for Action is URL.

Class com.amazonaws.services.pinpoint.model.DeleteAdmChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.DeleteAdmChannelResult extends java.lang.Object implements Serializable

Serialized Fields

aDMChannelResponse

ADMChannelResponse aDMChannelResponse

Amazon Device Messaging channel definition.

Class com.amazonaws.services.pinpoint.model.DeleteApnsChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.DeleteApnsChannelResult extends java.lang.Object implements Serializable

Serialized Fields

aPNSChannelResponse

APNSChannelResponse aPNSChannelResponse

Apple Distribution Push Notification Service channel definition.

Class com.amazonaws.services.pinpoint.model.DeleteApnsSandboxChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.DeleteApnsSandboxChannelResult extends java.lang.Object implements Serializable

Serialized Fields

aPNSSandboxChannelResponse

APNSSandboxChannelResponse aPNSSandboxChannelResponse

Apple Development Push Notification Service channel definition.

Class com.amazonaws.services.pinpoint.model.DeleteApnsVoipChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.DeleteApnsVoipChannelResult extends java.lang.Object implements Serializable

Serialized Fields

aPNSVoipChannelResponse

APNSVoipChannelResponse aPNSVoipChannelResponse

Apple VoIP Push Notification Service channel definition.

Class com.amazonaws.services.pinpoint.model.DeleteApnsVoipSandboxChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.DeleteApnsVoipSandboxChannelResult extends java.lang.Object implements Serializable

Serialized Fields

aPNSVoipSandboxChannelResponse

APNSVoipSandboxChannelResponse aPNSVoipSandboxChannelResponse

Apple VoIP Developer Push Notification Service channel definition.

Class com.amazonaws.services.pinpoint.model.DeleteAppRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.DeleteAppResult extends java.lang.Object implements Serializable

Serialized Fields

applicationResponse

ApplicationResponse applicationResponse

Application Response.

Class com.amazonaws.services.pinpoint.model.DeleteBaiduChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.DeleteBaiduChannelResult extends java.lang.Object implements Serializable

Serialized Fields

baiduChannelResponse

BaiduChannelResponse baiduChannelResponse

Baidu Cloud Messaging channel definition

Class com.amazonaws.services.pinpoint.model.DeleteCampaignRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

campaignId

java.lang.String campaignId

The unique ID of the campaign.

Class com.amazonaws.services.pinpoint.model.DeleteCampaignResult extends java.lang.Object implements Serializable

Serialized Fields

campaignResponse

CampaignResponse campaignResponse

Campaign definition

Class com.amazonaws.services.pinpoint.model.DeleteEmailChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.DeleteEmailChannelResult extends java.lang.Object implements Serializable

Serialized Fields

emailChannelResponse

EmailChannelResponse emailChannelResponse

Email Channel Response.

Class com.amazonaws.services.pinpoint.model.DeleteEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

endpointId

java.lang.String endpointId

The unique ID of the endpoint.

Class com.amazonaws.services.pinpoint.model.DeleteEndpointResult extends java.lang.Object implements Serializable

Serialized Fields

endpointResponse

EndpointResponse endpointResponse

Endpoint response

Class com.amazonaws.services.pinpoint.model.DeleteEventStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.DeleteEventStreamResult extends java.lang.Object implements Serializable

Serialized Fields

eventStream

EventStream eventStream

Model for an event publishing subscription export.

Class com.amazonaws.services.pinpoint.model.DeleteGcmChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.DeleteGcmChannelResult extends java.lang.Object implements Serializable

Serialized Fields

gCMChannelResponse

GCMChannelResponse gCMChannelResponse

Google Cloud Messaging channel definition

Class com.amazonaws.services.pinpoint.model.DeleteSegmentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

segmentId

java.lang.String segmentId

The unique ID of the segment.

Class com.amazonaws.services.pinpoint.model.DeleteSegmentResult extends java.lang.Object implements Serializable

Serialized Fields

segmentResponse

SegmentResponse segmentResponse

Segment definition.

Class com.amazonaws.services.pinpoint.model.DeleteSmsChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.DeleteSmsChannelResult extends java.lang.Object implements Serializable

Serialized Fields

sMSChannelResponse

SMSChannelResponse sMSChannelResponse

SMS Channel Response.

Class com.amazonaws.services.pinpoint.model.DeleteUserEndpointsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

userId

java.lang.String userId

The unique ID of the user.

Class com.amazonaws.services.pinpoint.model.DeleteUserEndpointsResult extends java.lang.Object implements Serializable

Serialized Fields

endpointsResponse

EndpointsResponse endpointsResponse

List of endpoints

Class com.amazonaws.services.pinpoint.model.DeleteVoiceChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.DeleteVoiceChannelResult extends java.lang.Object implements Serializable

Serialized Fields

voiceChannelResponse

VoiceChannelResponse voiceChannelResponse

Voice Channel Response.

Class com.amazonaws.services.pinpoint.model.DirectMessageConfiguration extends java.lang.Object implements Serializable

Serialized Fields

aDMMessage

ADMMessage aDMMessage

The message to ADM channels. Overrides the default push notification message.

aPNSMessage

APNSMessage aPNSMessage

The message to APNS channels. Overrides the default push notification message.

baiduMessage

BaiduMessage baiduMessage

The message to Baidu GCM channels. Overrides the default push notification message.

defaultMessage

DefaultMessage defaultMessage

The default message for all channels.

defaultPushNotificationMessage

DefaultPushNotificationMessage defaultPushNotificationMessage

The default push notification message for all push channels.

emailMessage

EmailMessage emailMessage

The message to Email channels. Overrides the default message.

gCMMessage

GCMMessage gCMMessage

The message to GCM channels. Overrides the default push notification message.

sMSMessage

SMSMessage sMSMessage

The message to SMS channels. Overrides the default message.

voiceMessage

VoiceMessage voiceMessage

The message to Voice channels. Overrides the default message.

Class com.amazonaws.services.pinpoint.model.EmailChannelRequest extends java.lang.Object implements Serializable

Serialized Fields

configurationSet

java.lang.String configurationSet

The configuration set that you want to use when you send email using the Pinpoint Email API.

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

fromAddress

java.lang.String fromAddress

The email address used to send emails from.

identity

java.lang.String identity

The ARN of an identity verified with SES.

roleArn

java.lang.String roleArn

The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service

Class com.amazonaws.services.pinpoint.model.EmailChannelResponse extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of the application to which the email channel belongs.

configurationSet

java.lang.String configurationSet

The configuration set that you want to use when you send email using the Pinpoint Email API.

creationDate

java.lang.String creationDate

The date that the settings were last updated in ISO 8601 format.

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

fromAddress

java.lang.String fromAddress

The email address used to send emails from.

hasCredential

java.lang.Boolean hasCredential

Not used. Retained for backwards compatibility.

id

java.lang.String id

Channel ID. Not used, only for backwards compatibility.

identity

java.lang.String identity

The ARN of an identity verified with SES.

isArchived

java.lang.Boolean isArchived

Is this channel archived

lastModifiedBy

java.lang.String lastModifiedBy

Who last updated this entry

lastModifiedDate

java.lang.String lastModifiedDate

Last date this was updated

messagesPerSecond

java.lang.Integer messagesPerSecond

Messages per second that can be sent

platform

java.lang.String platform

Platform type. Will be "EMAIL"

roleArn

java.lang.String roleArn

The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service

version

java.lang.Integer version

Version of channel

Class com.amazonaws.services.pinpoint.model.EmailMessage extends java.lang.Object implements Serializable

Serialized Fields

body

java.lang.String body

The body of the email message.

feedbackForwardingAddress

java.lang.String feedbackForwardingAddress

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.

fromAddress

java.lang.String fromAddress

The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.

rawEmail

RawEmail rawEmail

An email represented as a raw MIME message.

replyToAddresses

java.util.List<java.lang.String> replyToAddresses

The reply-to email address(es) for the email. If the recipient replies to the email, each reply-to address will receive the reply.

simpleEmail

SimpleEmail simpleEmail

An email composed of a subject, a text part and a html part.

substitutions

java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions

Default message substitutions. Can be overridden by individual address substitutions.

Class com.amazonaws.services.pinpoint.model.EndpointBatchItem extends java.lang.Object implements Serializable

Serialized Fields

address

java.lang.String address

The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the FCM registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

attributes

java.util.Map<java.lang.String,java.util.List<java.lang.String>> attributes

Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.

channelType

java.lang.String channelType

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

Constraints:
Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM

demographic

EndpointDemographic demographic

The endpoint demographic attributes.

effectiveDate

java.lang.String effectiveDate

The last time the endpoint was updated. Provided in ISO 8601 format.

endpointStatus

java.lang.String endpointStatus

Unused.

id

java.lang.String id

The unique Id for the Endpoint in the batch.

location

EndpointLocation location

The endpoint location attributes.

metrics

java.util.Map<java.lang.String,java.lang.Double> metrics

Custom metrics that your app reports to Amazon Pinpoint.

optOut

java.lang.String optOut

Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.

requestId

java.lang.String requestId

The unique ID for the most recent request to update the endpoint.

user

EndpointUser user

Custom user-specific attributes that your app reports to Amazon Pinpoint.

Class com.amazonaws.services.pinpoint.model.EndpointBatchRequest extends java.lang.Object implements Serializable

Serialized Fields

item

java.util.List<EndpointBatchItem> item

List of items to update. Maximum 100 items

Class com.amazonaws.services.pinpoint.model.EndpointDemographic extends java.lang.Object implements Serializable

Serialized Fields

appVersion

java.lang.String appVersion

The version of the application associated with the endpoint.

locale

java.lang.String locale

The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.

make

java.lang.String make

The manufacturer of the endpoint device, such as Apple or Samsung.

model

java.lang.String model

The model name or number of the endpoint device, such as iPhone.

modelVersion

java.lang.String modelVersion

The model version of the endpoint device.

platform

java.lang.String platform

The platform of the endpoint device, such as iOS or Android.

platformVersion

java.lang.String platformVersion

The platform version of the endpoint device.

timezone

java.lang.String timezone

The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.

Class com.amazonaws.services.pinpoint.model.EndpointItemResponse extends java.lang.Object implements Serializable

Serialized Fields

message

java.lang.String message

A custom message associated with the registration of an endpoint when issuing a response.

statusCode

java.lang.Integer statusCode

The status code associated with the merging of an endpoint when issuing a response.

Class com.amazonaws.services.pinpoint.model.EndpointLocation extends java.lang.Object implements Serializable

Serialized Fields

city

java.lang.String city

The city where the endpoint is located.

country

java.lang.String country

The two-letter code for the country or region of the endpoint. Specified as an ISO 3166-1 alpha-2 code, such as "US" for the United States.

latitude

java.lang.Double latitude

The latitude of the endpoint location, rounded to one decimal place.

longitude

java.lang.Double longitude

The longitude of the endpoint location, rounded to one decimal place.

postalCode

java.lang.String postalCode

The postal code or zip code of the endpoint.

region

java.lang.String region

The region of the endpoint location. For example, in the United States, this corresponds to a state.

Class com.amazonaws.services.pinpoint.model.EndpointMessageResult extends java.lang.Object implements Serializable

Serialized Fields

address

java.lang.String address

Address that endpoint message was delivered to.

deliveryStatus

java.lang.String deliveryStatus

The delivery status of the message. Possible values: SUCCESS - The message was successfully delivered to the endpoint. TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. TIMEOUT - The message couldn't be sent within the timeout period. QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app. DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. HOLDOUT - The endpoint was in a hold out treatment for the campaign. THROTTLED - Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The endpoint address is expired. CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. UNKNOWN - An unknown error occurred.

Constraints:
Allowed Values: SUCCESSFUL, THROTTLED, TEMPORARY_FAILURE, PERMANENT_FAILURE, UNKNOWN_FAILURE, OPT_OUT, DUPLICATE

messageId

java.lang.String messageId

Unique message identifier associated with the message that was sent.

statusCode

java.lang.Integer statusCode

Downstream service status code.

statusMessage

java.lang.String statusMessage

Status message for message delivery.

updatedToken

java.lang.String updatedToken

If token was updated as part of delivery. (This is GCM Specific)

Class com.amazonaws.services.pinpoint.model.EndpointRequest extends java.lang.Object implements Serializable

Serialized Fields

address

java.lang.String address

The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the FCM registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

attributes

java.util.Map<java.lang.String,java.util.List<java.lang.String>> attributes

Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.

channelType

java.lang.String channelType

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

Constraints:
Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM

demographic

EndpointDemographic demographic

Demographic attributes for the endpoint.

effectiveDate

java.lang.String effectiveDate

The date and time when the endpoint was updated, shown in ISO 8601 format.

endpointStatus

java.lang.String endpointStatus

Unused.

location

EndpointLocation location

The endpoint location attributes.

metrics

java.util.Map<java.lang.String,java.lang.Double> metrics

Custom metrics that your app reports to Amazon Pinpoint.

optOut

java.lang.String optOut

Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.

requestId

java.lang.String requestId

The unique ID for the most recent request to update the endpoint.

user

EndpointUser user

Custom user-specific attributes that your app reports to Amazon Pinpoint.

Class com.amazonaws.services.pinpoint.model.EndpointResponse extends java.lang.Object implements Serializable

Serialized Fields

address

java.lang.String address

The address of the endpoint as provided by your push provider. For example, the DeviceToken or RegistrationId.

applicationId

java.lang.String applicationId

The ID of the application that is associated with the endpoint.

attributes

java.util.Map<java.lang.String,java.util.List<java.lang.String>> attributes

Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.

channelType

java.lang.String channelType

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

Constraints:
Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM

cohortId

java.lang.String cohortId

A number from 0-99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.

creationDate

java.lang.String creationDate

The date and time when the endpoint was created, shown in ISO 8601 format.

demographic

EndpointDemographic demographic

The endpoint demographic attributes.

effectiveDate

java.lang.String effectiveDate

The date and time when the endpoint was last updated, shown in ISO 8601 format.

endpointStatus

java.lang.String endpointStatus

Unused.

id

java.lang.String id

The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint IDs associated with the application.

location

EndpointLocation location

The endpoint location attributes.

metrics

java.util.Map<java.lang.String,java.lang.Double> metrics

Custom metrics that your app reports to Amazon Pinpoint.

optOut

java.lang.String optOut

Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.

requestId

java.lang.String requestId

The unique ID for the most recent request to update the endpoint.

user

EndpointUser user

Custom user-specific attributes that your app reports to Amazon Pinpoint.

Class com.amazonaws.services.pinpoint.model.EndpointSendConfiguration extends java.lang.Object implements Serializable

Serialized Fields

bodyOverride

java.lang.String bodyOverride

Body override. If specified will override default body.

context

java.util.Map<java.lang.String,java.lang.String> context

A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.

rawContent

java.lang.String rawContent

The Raw JSON formatted string to be used as the payload. This value overrides the message.

substitutions

java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions

A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.

titleOverride

java.lang.String titleOverride

Title override. If specified will override default title if applicable.

Class com.amazonaws.services.pinpoint.model.EndpointsResponse extends java.lang.Object implements Serializable

Serialized Fields

item

java.util.List<EndpointResponse> item

The list of endpoints.

Class com.amazonaws.services.pinpoint.model.EndpointUser extends java.lang.Object implements Serializable

Serialized Fields

userAttributes

java.util.Map<java.lang.String,java.util.List<java.lang.String>> userAttributes

Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.

userId

java.lang.String userId

The unique ID of the user.

Class com.amazonaws.services.pinpoint.model.Event extends java.lang.Object implements Serializable

Serialized Fields

appPackageName

java.lang.String appPackageName

The package name associated with the app that's recording the event.

appTitle

java.lang.String appTitle

The title of the app that's recording the event.

appVersionCode

java.lang.String appVersionCode

The version number of the app that's recording the event.

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

Custom attributes that are associated with the event you're adding or updating.

clientSdkVersion

java.lang.String clientSdkVersion

The version of the SDK that's running on the client device.

eventType

java.lang.String eventType

The name of the custom event that you're recording.

metrics

java.util.Map<java.lang.String,java.lang.Double> metrics

Custom metrics related to the event.

sdkName

java.lang.String sdkName

The name of the SDK that's being used to record the event.

session

Session session

Information about the session in which the event occurred.

timestamp

java.lang.String timestamp

The date and time when the event occurred, in ISO 8601 format.

Class com.amazonaws.services.pinpoint.model.EventDimensions extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,AttributeDimension> attributes

Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

eventType

SetDimension eventType

The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.

metrics

java.util.Map<java.lang.String,MetricDimension> metrics

Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

Class com.amazonaws.services.pinpoint.model.EventItemResponse extends java.lang.Object implements Serializable

Serialized Fields

message

java.lang.String message

A custom message that is associated with the processing of an event.

statusCode

java.lang.Integer statusCode

The status returned in the response as a result of processing the event. Possible values: 400 (for invalid events) and 202 (for events that were accepted).

Class com.amazonaws.services.pinpoint.model.EventsBatch extends java.lang.Object implements Serializable

Serialized Fields

endpoint

PublicEndpoint endpoint

The PublicEndpoint attached to the EndpointId from the request.

events

java.util.Map<java.lang.String,Event> events

An object that contains a set of events associated with the endpoint.

Class com.amazonaws.services.pinpoint.model.EventsRequest extends java.lang.Object implements Serializable

Serialized Fields

batchItem

java.util.Map<java.lang.String,EventsBatch> batchItem

A batch of events to process. Each BatchItem consists of an endpoint ID as the key, and an EventsBatch object as the value.

Class com.amazonaws.services.pinpoint.model.EventsResponse extends java.lang.Object implements Serializable

Serialized Fields

results

java.util.Map<java.lang.String,ItemResponse> results

A map that contains a multipart response for each endpoint. Each item in this object uses the endpoint ID as the key, and the item response as the value. If no item response exists, the value can also be one of the following: 202 (if the request was processed successfully) or 400 (if the payload was invalid, or required fields were missing).

Class com.amazonaws.services.pinpoint.model.EventStream extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The ID of the application from which events should be published.

destinationStreamArn

java.lang.String destinationStreamArn

The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME

externalId

java.lang.String externalId

(Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

lastModifiedDate

java.lang.String lastModifiedDate

The date the event stream was last updated in ISO 8601 format.

lastUpdatedBy

java.lang.String lastUpdatedBy

The IAM user who last modified the event stream.

roleArn

java.lang.String roleArn

The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

Class com.amazonaws.services.pinpoint.model.ExportJobRequest extends java.lang.Object implements Serializable

Serialized Fields

roleArn

java.lang.String roleArn

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.

s3UrlPrefix

java.lang.String s3UrlPrefix

A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.

segmentId

java.lang.String segmentId

The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.

segmentVersion

java.lang.Integer segmentVersion

The version of the segment to export if specified.

Class com.amazonaws.services.pinpoint.model.ExportJobResource extends java.lang.Object implements Serializable

Serialized Fields

roleArn

java.lang.String roleArn

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.

s3UrlPrefix

java.lang.String s3UrlPrefix

A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.

segmentId

java.lang.String segmentId

The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.

segmentVersion

java.lang.Integer segmentVersion

The version of the segment to export if specified.

Class com.amazonaws.services.pinpoint.model.ExportJobResponse extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of the application associated with the export job.

completedPieces

java.lang.Integer completedPieces

The number of pieces that have successfully completed as of the time of the request.

completionDate

java.lang.String completionDate

The date the job completed in ISO 8601 format.

creationDate

java.lang.String creationDate

The date the job was created in ISO 8601 format.

definition

ExportJobResource definition

The export job settings.

failedPieces

java.lang.Integer failedPieces

The number of pieces that failed to be processed as of the time of the request.

failures

java.util.List<java.lang.String> failures

Provides up to 100 of the first failed entries for the job, if any exist.

id

java.lang.String id

The unique ID of the job.

jobStatus

java.lang.String jobStatus

The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.

Constraints:
Allowed Values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED

totalFailures

java.lang.Integer totalFailures

The number of endpoints that were not processed; for example, because of syntax errors.

totalPieces

java.lang.Integer totalPieces

The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.

totalProcessed

java.lang.Integer totalProcessed

The number of endpoints that were processed by the job.

type

java.lang.String type

The job type. Will be 'EXPORT'.

Class com.amazonaws.services.pinpoint.model.ExportJobsResponse extends java.lang.Object implements Serializable

Serialized Fields

item

java.util.List<ExportJobResponse> item

A list of export jobs for the application.

nextToken

java.lang.String nextToken

The string that you use in a subsequent request to get the next page of results in a paginated response.

Class com.amazonaws.services.pinpoint.model.ForbiddenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestID

java.lang.String requestID

The unique message body ID.

Class com.amazonaws.services.pinpoint.model.GCMChannelRequest extends java.lang.Object implements Serializable

Serialized Fields

apiKey

java.lang.String apiKey

Platform credential API key from Google.

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

Class com.amazonaws.services.pinpoint.model.GCMChannelResponse extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The ID of the application to which the channel applies.

creationDate

java.lang.String creationDate

When was this segment created

credential

java.lang.String credential

The GCM API key from Google.

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

hasCredential

java.lang.Boolean hasCredential

Not used. Retained for backwards compatibility.

id

java.lang.String id

Channel ID. Not used. Present only for backwards compatibility.

isArchived

java.lang.Boolean isArchived

Is this channel archived

lastModifiedBy

java.lang.String lastModifiedBy

Who last updated this entry

lastModifiedDate

java.lang.String lastModifiedDate

Last date this was updated

platform

java.lang.String platform

The platform type. Will be GCM

version

java.lang.Integer version

Version of channel

Class com.amazonaws.services.pinpoint.model.GCMMessage extends java.lang.Object implements Serializable

Serialized Fields

action

java.lang.String action

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

Constraints:
Allowed Values: OPEN_APP, DEEP_LINK, URL

body

java.lang.String body

The message body of the notification.

collapseKey

java.lang.String collapseKey

This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.

data

java.util.Map<java.lang.String,java.lang.String> data

The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object

iconReference

java.lang.String iconReference

The icon image name of the asset saved in your application.

imageIconUrl

java.lang.String imageIconUrl

The URL that points to an image used as the large icon to the notification content view.

imageUrl

java.lang.String imageUrl

The URL that points to an image used in the push notification.

priority

java.lang.String priority

The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values: "Normal" - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required. "High" - Messages are sent immediately and might wake a sleeping device. The equivalent values for APNs messages are "5" and "10". Amazon Pinpoint accepts these values here and converts them. For more information, see About FCM Messages in the Firebase documentation.

rawContent

java.lang.String rawContent

The Raw JSON formatted string to be used as the payload. This value overrides the message.

restrictedPackageName

java.lang.String restrictedPackageName

This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.

silentPush

java.lang.Boolean silentPush

Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

smallImageIconUrl

java.lang.String smallImageIconUrl

The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view

sound

java.lang.String sound

Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/

substitutions

java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions

Default message substitutions. Can be overridden by individual address substitutions.

timeToLive

java.lang.Integer timeToLive

The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter.

title

java.lang.String title

The message title that displays above the message on the user's device.

url

java.lang.String url

The URL to open in the user's mobile browser. Used if the value for Action is URL.

Class com.amazonaws.services.pinpoint.model.GetAdmChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.GetAdmChannelResult extends java.lang.Object implements Serializable

Serialized Fields

aDMChannelResponse

ADMChannelResponse aDMChannelResponse

Amazon Device Messaging channel definition.

Class com.amazonaws.services.pinpoint.model.GetApnsChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.GetApnsChannelResult extends java.lang.Object implements Serializable

Serialized Fields

aPNSChannelResponse

APNSChannelResponse aPNSChannelResponse

Apple Distribution Push Notification Service channel definition.

Class com.amazonaws.services.pinpoint.model.GetApnsSandboxChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.GetApnsSandboxChannelResult extends java.lang.Object implements Serializable

Serialized Fields

aPNSSandboxChannelResponse

APNSSandboxChannelResponse aPNSSandboxChannelResponse

Apple Development Push Notification Service channel definition.

Class com.amazonaws.services.pinpoint.model.GetApnsVoipChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.GetApnsVoipChannelResult extends java.lang.Object implements Serializable

Serialized Fields

aPNSVoipChannelResponse

APNSVoipChannelResponse aPNSVoipChannelResponse

Apple VoIP Push Notification Service channel definition.

Class com.amazonaws.services.pinpoint.model.GetApnsVoipSandboxChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.GetApnsVoipSandboxChannelResult extends java.lang.Object implements Serializable

Serialized Fields

aPNSVoipSandboxChannelResponse

APNSVoipSandboxChannelResponse aPNSVoipSandboxChannelResponse

Apple VoIP Developer Push Notification Service channel definition.

Class com.amazonaws.services.pinpoint.model.GetApplicationSettingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.GetApplicationSettingsResult extends java.lang.Object implements Serializable

Serialized Fields

applicationSettingsResource

ApplicationSettingsResource applicationSettingsResource

Application settings.

Class com.amazonaws.services.pinpoint.model.GetAppRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.GetAppResult extends java.lang.Object implements Serializable

Serialized Fields

applicationResponse

ApplicationResponse applicationResponse

Application Response.

Class com.amazonaws.services.pinpoint.model.GetAppsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pageSize

java.lang.String pageSize

The number of entries you want on each page in the response.

token

java.lang.String token

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Class com.amazonaws.services.pinpoint.model.GetAppsResult extends java.lang.Object implements Serializable

Serialized Fields

applicationsResponse

ApplicationsResponse applicationsResponse

Get Applications Result.

Class com.amazonaws.services.pinpoint.model.GetBaiduChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.GetBaiduChannelResult extends java.lang.Object implements Serializable

Serialized Fields

baiduChannelResponse

BaiduChannelResponse baiduChannelResponse

Baidu Cloud Messaging channel definition

Class com.amazonaws.services.pinpoint.model.GetCampaignActivitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

campaignId

java.lang.String campaignId

The unique ID of the campaign.

pageSize

java.lang.String pageSize

The number of entries you want on each page in the response.

token

java.lang.String token

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Class com.amazonaws.services.pinpoint.model.GetCampaignActivitiesResult extends java.lang.Object implements Serializable

Serialized Fields

activitiesResponse

ActivitiesResponse activitiesResponse

Activities for campaign.

Class com.amazonaws.services.pinpoint.model.GetCampaignRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

campaignId

java.lang.String campaignId

The unique ID of the campaign.

Class com.amazonaws.services.pinpoint.model.GetCampaignResult extends java.lang.Object implements Serializable

Serialized Fields

campaignResponse

CampaignResponse campaignResponse

Campaign definition

Class com.amazonaws.services.pinpoint.model.GetCampaignsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

pageSize

java.lang.String pageSize

The number of entries you want on each page in the response.

token

java.lang.String token

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Class com.amazonaws.services.pinpoint.model.GetCampaignsResult extends java.lang.Object implements Serializable

Serialized Fields

campaignsResponse

CampaignsResponse campaignsResponse

List of available campaigns.

Class com.amazonaws.services.pinpoint.model.GetCampaignVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

campaignId

java.lang.String campaignId

The unique ID of the campaign.

version

java.lang.String version

The version of the campaign.

Class com.amazonaws.services.pinpoint.model.GetCampaignVersionResult extends java.lang.Object implements Serializable

Serialized Fields

campaignResponse

CampaignResponse campaignResponse

Campaign definition

Class com.amazonaws.services.pinpoint.model.GetCampaignVersionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

campaignId

java.lang.String campaignId

The unique ID of the campaign.

pageSize

java.lang.String pageSize

The number of entries you want on each page in the response.

token

java.lang.String token

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Class com.amazonaws.services.pinpoint.model.GetCampaignVersionsResult extends java.lang.Object implements Serializable

Serialized Fields

campaignsResponse

CampaignsResponse campaignsResponse

List of available campaigns.

Class com.amazonaws.services.pinpoint.model.GetChannelsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.GetChannelsResult extends java.lang.Object implements Serializable

Serialized Fields

channelsResponse

ChannelsResponse channelsResponse

Get channels definition

Class com.amazonaws.services.pinpoint.model.GetEmailChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.GetEmailChannelResult extends java.lang.Object implements Serializable

Serialized Fields

emailChannelResponse

EmailChannelResponse emailChannelResponse

Email Channel Response.

Class com.amazonaws.services.pinpoint.model.GetEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

endpointId

java.lang.String endpointId

The unique ID of the endpoint.

Class com.amazonaws.services.pinpoint.model.GetEndpointResult extends java.lang.Object implements Serializable

Serialized Fields

endpointResponse

EndpointResponse endpointResponse

Endpoint response

Class com.amazonaws.services.pinpoint.model.GetEventStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.GetEventStreamResult extends java.lang.Object implements Serializable

Serialized Fields

eventStream

EventStream eventStream

Model for an event publishing subscription export.

Class com.amazonaws.services.pinpoint.model.GetExportJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

jobId

java.lang.String jobId

The unique ID of the job.

Class com.amazonaws.services.pinpoint.model.GetExportJobResult extends java.lang.Object implements Serializable

Serialized Fields

exportJobResponse

ExportJobResponse exportJobResponse

Export job response.

Class com.amazonaws.services.pinpoint.model.GetExportJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

pageSize

java.lang.String pageSize

The number of entries you want on each page in the response.

token

java.lang.String token

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Class com.amazonaws.services.pinpoint.model.GetExportJobsResult extends java.lang.Object implements Serializable

Serialized Fields

exportJobsResponse

ExportJobsResponse exportJobsResponse

Export job list.

Class com.amazonaws.services.pinpoint.model.GetGcmChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.GetGcmChannelResult extends java.lang.Object implements Serializable

Serialized Fields

gCMChannelResponse

GCMChannelResponse gCMChannelResponse

Google Cloud Messaging channel definition

Class com.amazonaws.services.pinpoint.model.GetImportJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

jobId

java.lang.String jobId

The unique ID of the job.

Class com.amazonaws.services.pinpoint.model.GetImportJobResult extends java.lang.Object implements Serializable

Serialized Fields

importJobResponse

ImportJobResponse importJobResponse

Import job response.

Class com.amazonaws.services.pinpoint.model.GetImportJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

pageSize

java.lang.String pageSize

The number of entries you want on each page in the response.

token

java.lang.String token

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Class com.amazonaws.services.pinpoint.model.GetImportJobsResult extends java.lang.Object implements Serializable

Serialized Fields

importJobsResponse

ImportJobsResponse importJobsResponse

Import job list.

Class com.amazonaws.services.pinpoint.model.GetSegmentExportJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

pageSize

java.lang.String pageSize

The number of entries you want on each page in the response.

segmentId

java.lang.String segmentId

The unique ID of the segment.

token

java.lang.String token

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Class com.amazonaws.services.pinpoint.model.GetSegmentExportJobsResult extends java.lang.Object implements Serializable

Serialized Fields

exportJobsResponse

ExportJobsResponse exportJobsResponse

Export job list.

Class com.amazonaws.services.pinpoint.model.GetSegmentImportJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

pageSize

java.lang.String pageSize

The number of entries you want on each page in the response.

segmentId

java.lang.String segmentId

The unique ID of the segment.

token

java.lang.String token

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Class com.amazonaws.services.pinpoint.model.GetSegmentImportJobsResult extends java.lang.Object implements Serializable

Serialized Fields

importJobsResponse

ImportJobsResponse importJobsResponse

Import job list.

Class com.amazonaws.services.pinpoint.model.GetSegmentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

segmentId

java.lang.String segmentId

The unique ID of the segment.

Class com.amazonaws.services.pinpoint.model.GetSegmentResult extends java.lang.Object implements Serializable

Serialized Fields

segmentResponse

SegmentResponse segmentResponse

Segment definition.

Class com.amazonaws.services.pinpoint.model.GetSegmentsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

pageSize

java.lang.String pageSize

The number of entries you want on each page in the response.

token

java.lang.String token

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Class com.amazonaws.services.pinpoint.model.GetSegmentsResult extends java.lang.Object implements Serializable

Serialized Fields

segmentsResponse

SegmentsResponse segmentsResponse

Segments in your account.

Class com.amazonaws.services.pinpoint.model.GetSegmentVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

segmentId

java.lang.String segmentId

The unique ID of the segment.

version

java.lang.String version

The segment version.

Class com.amazonaws.services.pinpoint.model.GetSegmentVersionResult extends java.lang.Object implements Serializable

Serialized Fields

segmentResponse

SegmentResponse segmentResponse

Segment definition.

Class com.amazonaws.services.pinpoint.model.GetSegmentVersionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

pageSize

java.lang.String pageSize

The number of entries you want on each page in the response.

segmentId

java.lang.String segmentId

The unique ID of the segment.

token

java.lang.String token

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Class com.amazonaws.services.pinpoint.model.GetSegmentVersionsResult extends java.lang.Object implements Serializable

Serialized Fields

segmentsResponse

SegmentsResponse segmentsResponse

Segments in your account.

Class com.amazonaws.services.pinpoint.model.GetSmsChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.GetSmsChannelResult extends java.lang.Object implements Serializable

Serialized Fields

sMSChannelResponse

SMSChannelResponse sMSChannelResponse

SMS Channel Response.

Class com.amazonaws.services.pinpoint.model.GetUserEndpointsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

userId

java.lang.String userId

The unique ID of the user.

Class com.amazonaws.services.pinpoint.model.GetUserEndpointsResult extends java.lang.Object implements Serializable

Serialized Fields

endpointsResponse

EndpointsResponse endpointsResponse

List of endpoints

Class com.amazonaws.services.pinpoint.model.GetVoiceChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.GetVoiceChannelResult extends java.lang.Object implements Serializable

Serialized Fields

voiceChannelResponse

VoiceChannelResponse voiceChannelResponse

Voice Channel Response.

Class com.amazonaws.services.pinpoint.model.GPSCoordinates extends java.lang.Object implements Serializable

Serialized Fields

latitude

java.lang.Double latitude

Latitude

longitude

java.lang.Double longitude

Longitude

Class com.amazonaws.services.pinpoint.model.GPSPointDimension extends java.lang.Object implements Serializable

Serialized Fields

coordinates

GPSCoordinates coordinates

Coordinate to measure distance from.

rangeInKilometers

java.lang.Double rangeInKilometers

Range in kilometers from the coordinate.

Class com.amazonaws.services.pinpoint.model.ImportJobRequest extends java.lang.Object implements Serializable

Serialized Fields

defineSegment

java.lang.Boolean defineSegment

Sets whether the endpoints create a segment when they are imported.

externalId

java.lang.String externalId

(Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

format

java.lang.String format

The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

Constraints:
Allowed Values: CSV, JSON

registerEndpoints

java.lang.Boolean registerEndpoints

Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.

roleArn

java.lang.String roleArn

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.

s3Url

java.lang.String s3Url

The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.

segmentId

java.lang.String segmentId

The ID of the segment to update if the import job is meant to update an existing segment.

segmentName

java.lang.String segmentName

A custom name for the segment created by the import job. Use if DefineSegment is true.

Class com.amazonaws.services.pinpoint.model.ImportJobResource extends java.lang.Object implements Serializable

Serialized Fields

defineSegment

java.lang.Boolean defineSegment

Sets whether the endpoints create a segment when they are imported.

externalId

java.lang.String externalId

(Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

format

java.lang.String format

The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

Constraints:
Allowed Values: CSV, JSON

registerEndpoints

java.lang.Boolean registerEndpoints

Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.

roleArn

java.lang.String roleArn

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.

s3Url

java.lang.String s3Url

The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.

segmentId

java.lang.String segmentId

The ID of the segment to update if the import job is meant to update an existing segment.

segmentName

java.lang.String segmentName

A custom name for the segment created by the import job. Use if DefineSegment is true.

Class com.amazonaws.services.pinpoint.model.ImportJobResponse extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of the application to which the import job applies.

completedPieces

java.lang.Integer completedPieces

The number of pieces that have successfully imported as of the time of the request.

completionDate

java.lang.String completionDate

The date the import job completed in ISO 8601 format.

creationDate

java.lang.String creationDate

The date the import job was created in ISO 8601 format.

definition

ImportJobResource definition

The import job settings.

failedPieces

java.lang.Integer failedPieces

The number of pieces that have failed to import as of the time of the request.

failures

java.util.List<java.lang.String> failures

Provides up to 100 of the first failed entries for the job, if any exist.

id

java.lang.String id

The unique ID of the import job.

jobStatus

java.lang.String jobStatus

The status of the import job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed to import.

Constraints:
Allowed Values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED

totalFailures

java.lang.Integer totalFailures

The number of endpoints that failed to import; for example, because of syntax errors.

totalPieces

java.lang.Integer totalPieces

The total number of pieces that must be imported to finish the job. Each piece is an approximately equal portion of the endpoints to import.

totalProcessed

java.lang.Integer totalProcessed

The number of endpoints that were processed by the import job.

type

java.lang.String type

The job type. Will be Import.

Class com.amazonaws.services.pinpoint.model.ImportJobsResponse extends java.lang.Object implements Serializable

Serialized Fields

item

java.util.List<ImportJobResponse> item

A list of import jobs for the application.

nextToken

java.lang.String nextToken

The string that you use in a subsequent request to get the next page of results in a paginated response.

Class com.amazonaws.services.pinpoint.model.InternalServerErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestID

java.lang.String requestID

The unique message body ID.

Class com.amazonaws.services.pinpoint.model.ItemResponse extends java.lang.Object implements Serializable

Serialized Fields

endpointItemResponse

EndpointItemResponse endpointItemResponse

The response received after the endpoint was accepted.

eventsItemResponse

java.util.Map<java.lang.String,EventItemResponse> eventsItemResponse

A multipart response object that contains a key and value for each event ID in the request. In each object, the event ID is the key, and an EventItemResponse object is the value.

Class com.amazonaws.services.pinpoint.model.Message extends java.lang.Object implements Serializable

Serialized Fields

action

java.lang.String action

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.

Constraints:
Allowed Values: OPEN_APP, DEEP_LINK, URL

body

java.lang.String body

The message body. Can include up to 140 characters.

imageIconUrl

java.lang.String imageIconUrl

The URL that points to the icon image for the push notification icon, for example, the app icon.

imageSmallIconUrl

java.lang.String imageSmallIconUrl

The URL that points to the small icon image for the push notification icon, for example, the app icon.

imageUrl

java.lang.String imageUrl

The URL that points to an image used in the push notification.

jsonBody

java.lang.String jsonBody

The JSON payload used for a silent push.

mediaUrl

java.lang.String mediaUrl

A URL that refers to the location of an image or video that you want to display in the push notification.

rawContent

java.lang.String rawContent

The Raw JSON formatted string to be used as the payload. This value overrides the message.

silentPush

java.lang.Boolean silentPush

Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

timeToLive

java.lang.Integer timeToLive

This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM

title

java.lang.String title

The message title that displays above the message on the user's device.

url

java.lang.String url

The URL to open in the user's mobile browser. Used if the value for Action is URL.

Class com.amazonaws.services.pinpoint.model.MessageBody extends java.lang.Object implements Serializable

Serialized Fields

message

java.lang.String message

The error message that's returned from the API.

requestID

java.lang.String requestID

The unique message body ID.

Class com.amazonaws.services.pinpoint.model.MessageConfiguration extends java.lang.Object implements Serializable

Serialized Fields

aDMMessage

Message aDMMessage

The message that the campaign delivers to ADM channels. Overrides the default message.

aPNSMessage

Message aPNSMessage

The message that the campaign delivers to APNS channels. Overrides the default message.

baiduMessage

Message baiduMessage

The message that the campaign delivers to Baidu channels. Overrides the default message.

defaultMessage

Message defaultMessage

The default message for all channels.

emailMessage

CampaignEmailMessage emailMessage

The email message configuration.

gCMMessage

Message gCMMessage

The message that the campaign delivers to GCM channels. Overrides the default message.

sMSMessage

CampaignSmsMessage sMSMessage

The SMS message configuration.

Class com.amazonaws.services.pinpoint.model.MessageRequest extends java.lang.Object implements Serializable

Serialized Fields

addresses

java.util.Map<java.lang.String,AddressConfiguration> addresses

A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address.

context

java.util.Map<java.lang.String,java.lang.String> context

A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.

endpoints

java.util.Map<java.lang.String,EndpointSendConfiguration> endpoints

A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. Within an EndpointSendConfiguration object, you can tailor the message for an endpoint by specifying message overrides or substitutions.

messageConfiguration

DirectMessageConfiguration messageConfiguration

Message configuration.

traceId

java.lang.String traceId

A unique ID that you can use to trace a message. This ID is visible to recipients.

Class com.amazonaws.services.pinpoint.model.MessageResponse extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

Application id of the message.

endpointResult

java.util.Map<java.lang.String,EndpointMessageResult> endpointResult

A map containing a multi part response for each address, with the endpointId as the key and the result as the value.

requestId

java.lang.String requestId

Original request Id for which this message was delivered.

result

java.util.Map<java.lang.String,MessageResult> result

A map containing a multi part response for each address, with the address as the key(Email address, phone number or push token) and the result as the value.

Class com.amazonaws.services.pinpoint.model.MessageResult extends java.lang.Object implements Serializable

Serialized Fields

deliveryStatus

java.lang.String deliveryStatus

The delivery status of the message. Possible values: SUCCESS - The message was successfully delivered to the endpoint. TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. TIMEOUT - The message couldn't be sent within the timeout period. QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app. DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. HOLDOUT - The endpoint was in a hold out treatment for the campaign. THROTTLED - Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The endpoint address is expired. CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. UNKNOWN - An unknown error occurred.

Constraints:
Allowed Values: SUCCESSFUL, THROTTLED, TEMPORARY_FAILURE, PERMANENT_FAILURE, UNKNOWN_FAILURE, OPT_OUT, DUPLICATE

messageId

java.lang.String messageId

Unique message identifier associated with the message that was sent.

statusCode

java.lang.Integer statusCode

Downstream service status code.

statusMessage

java.lang.String statusMessage

Status message for message delivery.

updatedToken

java.lang.String updatedToken

If token was updated as part of delivery. (This is GCM Specific)

Class com.amazonaws.services.pinpoint.model.MethodNotAllowedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestID

java.lang.String requestID

The unique message body ID.

Class com.amazonaws.services.pinpoint.model.MetricDimension extends java.lang.Object implements Serializable

Serialized Fields

comparisonOperator

java.lang.String comparisonOperator

The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL

value

java.lang.Double value

The value to be compared.

Class com.amazonaws.services.pinpoint.model.NotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestID

java.lang.String requestID

The unique message body ID.

Class com.amazonaws.services.pinpoint.model.NumberValidateRequest extends java.lang.Object implements Serializable

Serialized Fields

isoCountryCode

java.lang.String isoCountryCode

(Optional) The two-character ISO country code for the country or region where the phone number was originally registered.

phoneNumber

java.lang.String phoneNumber

The phone number to get information about. The phone number that you provide should include a country code. If the number doesn't include a valid country code, the operation might result in an error.

Class com.amazonaws.services.pinpoint.model.NumberValidateResponse extends java.lang.Object implements Serializable

Serialized Fields

carrier

java.lang.String carrier

The carrier or servive provider that the phone number is currently registered with.

city

java.lang.String city

The city where the phone number was originally registered.

cleansedPhoneNumberE164

java.lang.String cleansedPhoneNumberE164

The cleansed phone number, shown in E.164 format.

cleansedPhoneNumberNational

java.lang.String cleansedPhoneNumberNational

The cleansed phone number, shown in the local phone number format.

country

java.lang.String country

The country or region where the phone number was originally registered.

countryCodeIso2

java.lang.String countryCodeIso2

The two-character ISO code for the country or region where the phone number was originally registered.

countryCodeNumeric

java.lang.String countryCodeNumeric

The numeric code for the country or region where the phone number was originally registered.

county

java.lang.String county

The county where the phone number was originally registered.

originalCountryCodeIso2

java.lang.String originalCountryCodeIso2

The two-character code (in ISO 3166-1 alpha-2 format) for the country or region in the request body.

originalPhoneNumber

java.lang.String originalPhoneNumber

The phone number that you included in the request body.

phoneType

java.lang.String phoneType

A description of the phone type. Possible values are MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.

phoneTypeCode

java.lang.Integer phoneTypeCode

The phone type, represented by an integer. Possible values include 0 (MOBILE), 1 (LANDLINE), 2 (VOIP), 3 (INVALID), 4 (OTHER), and 5 (PREPAID).

timezone

java.lang.String timezone

The time zone for the location where the phone number was originally registered.

zipCode

java.lang.String zipCode

The postal code for the location where the phone number was originally registered.

Class com.amazonaws.services.pinpoint.model.PhoneNumberValidateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

numberValidateRequest

NumberValidateRequest numberValidateRequest

Phone Number Validate request.

Class com.amazonaws.services.pinpoint.model.PhoneNumberValidateResult extends java.lang.Object implements Serializable

Serialized Fields

numberValidateResponse

NumberValidateResponse numberValidateResponse

Phone Number Validate response.

Class com.amazonaws.services.pinpoint.model.PublicEndpoint extends java.lang.Object implements Serializable

Serialized Fields

address

java.lang.String address

The unique identifier for the recipient. For example, an address could be a device token, email address, or mobile phone number.

attributes

java.util.Map<java.lang.String,java.util.List<java.lang.String>> attributes

Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.

channelType

java.lang.String channelType

The channel type. Valid values: APNS, GCM

Constraints:
Allowed Values: GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM

demographic

EndpointDemographic demographic

The endpoint demographic attributes.

effectiveDate

java.lang.String effectiveDate

The date and time when the endpoint was last updated, in ISO 8601 format.

endpointStatus

java.lang.String endpointStatus

The status of the endpoint. If the update fails, the value is INACTIVE. If the endpoint is updated successfully, the value is ACTIVE.

location

EndpointLocation location

The endpoint location attributes.

metrics

java.util.Map<java.lang.String,java.lang.Double> metrics

Custom metrics that your app reports to Amazon Pinpoint.

optOut

java.lang.String optOut

Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.

requestId

java.lang.String requestId

A unique identifier that is generated each time the endpoint is updated.

user

EndpointUser user

Custom user-specific attributes that your app reports to Amazon Pinpoint.

Class com.amazonaws.services.pinpoint.model.PutEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

eventsRequest

EventsRequest eventsRequest

A set of events to process.

Class com.amazonaws.services.pinpoint.model.PutEventsResult extends java.lang.Object implements Serializable

Serialized Fields

eventsResponse

EventsResponse eventsResponse

Custom messages associated with events.

Class com.amazonaws.services.pinpoint.model.PutEventStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

writeEventStream

WriteEventStream writeEventStream

Request to save an EventStream.

Class com.amazonaws.services.pinpoint.model.PutEventStreamResult extends java.lang.Object implements Serializable

Serialized Fields

eventStream

EventStream eventStream

Model for an event publishing subscription export.

Class com.amazonaws.services.pinpoint.model.QuietTime extends java.lang.Object implements Serializable

Serialized Fields

end

java.lang.String end

The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

start

java.lang.String start

The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

Class com.amazonaws.services.pinpoint.model.RawEmail extends java.lang.Object implements Serializable

Serialized Fields

data

java.nio.ByteBuffer data

The raw email message itself. Then entire message must be base64-encoded.

Class com.amazonaws.services.pinpoint.model.RecencyDimension extends java.lang.Object implements Serializable

Serialized Fields

duration

java.lang.String duration

The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30

Constraints:
Allowed Values: HR_24, DAY_7, DAY_14, DAY_30

recencyType

java.lang.String recencyType

The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Class com.amazonaws.services.pinpoint.model.RemoveAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

attributeType

java.lang.String attributeType

Type of attribute. Can be endpoint-custom-attributes, endpoint-custom-metrics, endpoint-user-attributes.

updateAttributesRequest

UpdateAttributesRequest updateAttributesRequest

Update attributes request

Class com.amazonaws.services.pinpoint.model.RemoveAttributesResult extends java.lang.Object implements Serializable

Serialized Fields

attributesResource

AttributesResource attributesResource

Attributes.

Class com.amazonaws.services.pinpoint.model.Schedule extends java.lang.Object implements Serializable

Serialized Fields

endTime

java.lang.String endTime

The scheduled time that the campaign ends in ISO 8601 format.

eventFilter

CampaignEventFilter eventFilter

Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.

frequency

java.lang.String frequency

How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT

Constraints:
Allowed Values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT

isLocalTime

java.lang.Boolean isLocalTime

Indicates whether the campaign schedule takes effect according to each user's local time.

quietTime

QuietTime quietTime

The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.

startTime

java.lang.String startTime

The scheduled time that the campaign begins in ISO 8601 format.

timezone

java.lang.String timezone

The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: UTC UTC+01 UTC+02 UTC+03 UTC+03:30 UTC+04 UTC+04:30 UTC+05 UTC+05:30 UTC+05:45 UTC+06 UTC+06:30 UTC+07 UTC+08 UTC+09 UTC+09:30 UTC+10 UTC+10:30 UTC+11 UTC+12 UTC+13 UTC-02 UTC-03 UTC-04 UTC-05 UTC-06 UTC-07 UTC-08 UTC-09 UTC-10 UTC-11

Class com.amazonaws.services.pinpoint.model.SegmentBehaviors extends java.lang.Object implements Serializable

Serialized Fields

recency

RecencyDimension recency

The recency of use.

Class com.amazonaws.services.pinpoint.model.SegmentDemographics extends java.lang.Object implements Serializable

Serialized Fields

appVersion

SetDimension appVersion

The app version criteria for the segment.

channel

SetDimension channel

The channel criteria for the segment.

deviceType

SetDimension deviceType

The device type criteria for the segment.

make

SetDimension make

The device make criteria for the segment.

model

SetDimension model

The device model criteria for the segment.

platform

SetDimension platform

The device platform criteria for the segment.

Class com.amazonaws.services.pinpoint.model.SegmentDimensions extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,AttributeDimension> attributes

Custom segment attributes.

behavior

SegmentBehaviors behavior

The segment behaviors attributes.

demographic

SegmentDemographics demographic

The segment demographics attributes.

location

SegmentLocation location

The segment location attributes.

metrics

java.util.Map<java.lang.String,MetricDimension> metrics

Custom segment metrics.

userAttributes

java.util.Map<java.lang.String,AttributeDimension> userAttributes

Custom segment user attributes.

Class com.amazonaws.services.pinpoint.model.SegmentGroup extends java.lang.Object implements Serializable

Serialized Fields

dimensions

java.util.List<SegmentDimensions> dimensions

List of dimensions to include or exclude.

sourceSegments

java.util.List<SegmentReference> sourceSegments

The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.

sourceType

java.lang.String sourceType

Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL.

Constraints:
Allowed Values: ALL, ANY, NONE

type

java.lang.String type

Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE.

Constraints:
Allowed Values: ALL, ANY, NONE

Class com.amazonaws.services.pinpoint.model.SegmentGroupList extends java.lang.Object implements Serializable

Serialized Fields

groups

java.util.List<SegmentGroup> groups

A set of segment criteria to evaluate.

include

java.lang.String include

Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE.

Constraints:
Allowed Values: ALL, ANY, NONE

Class com.amazonaws.services.pinpoint.model.SegmentImportResource extends java.lang.Object implements Serializable

Serialized Fields

channelCounts

java.util.Map<java.lang.String,java.lang.Integer> channelCounts

The number of channel types in the imported segment.

externalId

java.lang.String externalId

(Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

format

java.lang.String format

The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON

Constraints:
Allowed Values: CSV, JSON

roleArn

java.lang.String roleArn

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.

s3Url

java.lang.String s3Url

The URL of the S3 bucket that the segment was imported from.

size

java.lang.Integer size

The number of endpoints that were successfully imported to create this segment.

Class com.amazonaws.services.pinpoint.model.SegmentLocation extends java.lang.Object implements Serializable

Serialized Fields

country

SetDimension country

The country or region, in ISO 3166-1 alpha-2 format.

gPSPoint

GPSPointDimension gPSPoint

The GPS Point dimension.

Class com.amazonaws.services.pinpoint.model.SegmentReference extends java.lang.Object implements Serializable

Serialized Fields

id

java.lang.String id

A unique identifier for the segment.

version

java.lang.Integer version

If specified contains a specific version of the segment included.

Class com.amazonaws.services.pinpoint.model.SegmentResponse extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The ID of the application that the segment applies to.

creationDate

java.lang.String creationDate

The date and time when the segment was created.

dimensions

SegmentDimensions dimensions

The segment dimensions attributes.

id

java.lang.String id

The unique segment ID.

importDefinition

SegmentImportResource importDefinition

The import job settings.

lastModifiedDate

java.lang.String lastModifiedDate

The date and time when the segment was last modified.

name

java.lang.String name

The name of the segment.

segmentGroups

SegmentGroupList segmentGroups

A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.

segmentType

java.lang.String segmentType

The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.

Constraints:
Allowed Values: DIMENSIONAL, IMPORT

version

java.lang.Integer version

The segment version number.

Class com.amazonaws.services.pinpoint.model.SegmentsResponse extends java.lang.Object implements Serializable

Serialized Fields

item

java.util.List<SegmentResponse> item

The list of segments.

nextToken

java.lang.String nextToken

An identifier used to retrieve the next page of results. The token is null if no additional pages exist.

Class com.amazonaws.services.pinpoint.model.SendMessagesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

messageRequest

MessageRequest messageRequest

Send message request.

Class com.amazonaws.services.pinpoint.model.SendMessagesResult extends java.lang.Object implements Serializable

Serialized Fields

messageResponse

MessageResponse messageResponse

Send message response.

Class com.amazonaws.services.pinpoint.model.SendUsersMessageRequest extends java.lang.Object implements Serializable

Serialized Fields

context

java.util.Map<java.lang.String,java.lang.String> context

A map of custom attribute-value pairs. Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the push notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.

messageConfiguration

DirectMessageConfiguration messageConfiguration

Message definitions for the default message and any messages that are tailored for specific channels.

traceId

java.lang.String traceId

A unique ID that you can use to trace a message. This ID is visible to recipients.

users

java.util.Map<java.lang.String,EndpointSendConfiguration> users

A map that associates user IDs with EndpointSendConfiguration objects. Within an EndpointSendConfiguration object, you can tailor the message for a user by specifying message overrides or substitutions.

Class com.amazonaws.services.pinpoint.model.SendUsersMessageResponse extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of the Amazon Pinpoint project used to send the message.

requestId

java.lang.String requestId

The unique ID assigned to the users-messages request.

result

java.util.Map<java.lang.String,java.util.Map<java.lang.String,EndpointMessageResult>> result

An object that shows the endpoints that were messaged for each user. The object provides a list of user IDs. For each user ID, it provides the endpoint IDs that were messaged. For each endpoint ID, it provides an EndpointMessageResult object.

Class com.amazonaws.services.pinpoint.model.SendUsersMessagesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

sendUsersMessageRequest

SendUsersMessageRequest sendUsersMessageRequest

Send message request.

Class com.amazonaws.services.pinpoint.model.SendUsersMessagesResult extends java.lang.Object implements Serializable

Serialized Fields

sendUsersMessageResponse

SendUsersMessageResponse sendUsersMessageResponse

User send message response.

Class com.amazonaws.services.pinpoint.model.Session extends java.lang.Object implements Serializable

Serialized Fields

duration

java.lang.Integer duration

The duration of the session, in milliseconds.

id

java.lang.String id

A unique identifier for the session.

startTimestamp

java.lang.String startTimestamp

The date and time when the session began.

stopTimestamp

java.lang.String stopTimestamp

The date and time when the session ended.

Class com.amazonaws.services.pinpoint.model.SetDimension extends java.lang.Object implements Serializable

Serialized Fields

dimensionType

java.lang.String dimensionType

The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.

Constraints:
Allowed Values: INCLUSIVE, EXCLUSIVE

values

java.util.List<java.lang.String> values

The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.

Class com.amazonaws.services.pinpoint.model.SimpleEmail extends java.lang.Object implements Serializable

Serialized Fields

htmlPart

SimpleEmailPart htmlPart

The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.

subject

SimpleEmailPart subject

The subject of the message: A short summary of the content, which will appear in the recipient's inbox.

textPart

SimpleEmailPart textPart

The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).

Class com.amazonaws.services.pinpoint.model.SimpleEmailPart extends java.lang.Object implements Serializable

Serialized Fields

charset

java.lang.String charset

The character set of the content.

data

java.lang.String data

The textual data of the content.

Class com.amazonaws.services.pinpoint.model.SMSChannelRequest extends java.lang.Object implements Serializable

Serialized Fields

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

senderId

java.lang.String senderId

Sender identifier of your messages.

shortCode

java.lang.String shortCode

ShortCode registered with phone provider.

Class com.amazonaws.services.pinpoint.model.SMSChannelResponse extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of the application to which the SMS channel belongs.

creationDate

java.lang.String creationDate

The date that the settings were last updated in ISO 8601 format.

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

hasCredential

java.lang.Boolean hasCredential

Not used. Retained for backwards compatibility.

id

java.lang.String id

Channel ID. Not used, only for backwards compatibility.

isArchived

java.lang.Boolean isArchived

Is this channel archived

lastModifiedBy

java.lang.String lastModifiedBy

Who last updated this entry

lastModifiedDate

java.lang.String lastModifiedDate

Last date this was updated

platform

java.lang.String platform

Platform type. Will be "SMS"

promotionalMessagesPerSecond

java.lang.Integer promotionalMessagesPerSecond

Promotional messages per second that can be sent

senderId

java.lang.String senderId

Sender identifier of your messages.

shortCode

java.lang.String shortCode

The short code registered with the phone provider.

transactionalMessagesPerSecond

java.lang.Integer transactionalMessagesPerSecond

Transactional messages per second that can be sent

version

java.lang.Integer version

Version of channel

Class com.amazonaws.services.pinpoint.model.SMSMessage extends java.lang.Object implements Serializable

Serialized Fields

body

java.lang.String body

The body of the SMS message.

keyword

java.lang.String keyword

The SMS program name that you provided to AWS Support when you requested your dedicated number.

messageType

java.lang.String messageType

Is this a transaction priority message or lower priority.

Constraints:
Allowed Values: TRANSACTIONAL, PROMOTIONAL

originationNumber

java.lang.String originationNumber

The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.

senderId

java.lang.String senderId

The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.

substitutions

java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions

Default message substitutions. Can be overridden by individual address substitutions.

Class com.amazonaws.services.pinpoint.model.TooManyRequestsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestID

java.lang.String requestID

The unique message body ID.

Class com.amazonaws.services.pinpoint.model.TreatmentResource extends java.lang.Object implements Serializable

Serialized Fields

id

java.lang.String id

The unique treatment ID.

messageConfiguration

MessageConfiguration messageConfiguration

The message configuration settings.

schedule

Schedule schedule

The campaign schedule.

sizePercent

java.lang.Integer sizePercent

The allocated percentage of users for this treatment.

state

CampaignState state

The treatment status.

treatmentDescription

java.lang.String treatmentDescription

A custom description for the treatment.

treatmentName

java.lang.String treatmentName

The custom name of a variation of the campaign used for A/B testing.

Class com.amazonaws.services.pinpoint.model.UpdateAdmChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aDMChannelRequest

ADMChannelRequest aDMChannelRequest

Amazon Device Messaging channel definition.

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.UpdateAdmChannelResult extends java.lang.Object implements Serializable

Serialized Fields

aDMChannelResponse

ADMChannelResponse aDMChannelResponse

Amazon Device Messaging channel definition.

Class com.amazonaws.services.pinpoint.model.UpdateApnsChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aPNSChannelRequest

APNSChannelRequest aPNSChannelRequest

Apple Push Notification Service channel definition.

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.UpdateApnsChannelResult extends java.lang.Object implements Serializable

Serialized Fields

aPNSChannelResponse

APNSChannelResponse aPNSChannelResponse

Apple Distribution Push Notification Service channel definition.

Class com.amazonaws.services.pinpoint.model.UpdateApnsSandboxChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aPNSSandboxChannelRequest

APNSSandboxChannelRequest aPNSSandboxChannelRequest

Apple Development Push Notification Service channel definition.

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.UpdateApnsSandboxChannelResult extends java.lang.Object implements Serializable

Serialized Fields

aPNSSandboxChannelResponse

APNSSandboxChannelResponse aPNSSandboxChannelResponse

Apple Development Push Notification Service channel definition.

Class com.amazonaws.services.pinpoint.model.UpdateApnsVoipChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aPNSVoipChannelRequest

APNSVoipChannelRequest aPNSVoipChannelRequest

Apple VoIP Push Notification Service channel definition.

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.UpdateApnsVoipChannelResult extends java.lang.Object implements Serializable

Serialized Fields

aPNSVoipChannelResponse

APNSVoipChannelResponse aPNSVoipChannelResponse

Apple VoIP Push Notification Service channel definition.

Class com.amazonaws.services.pinpoint.model.UpdateApnsVoipSandboxChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aPNSVoipSandboxChannelRequest

APNSVoipSandboxChannelRequest aPNSVoipSandboxChannelRequest

Apple VoIP Developer Push Notification Service channel definition.

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

Class com.amazonaws.services.pinpoint.model.UpdateApnsVoipSandboxChannelResult extends java.lang.Object implements Serializable

Serialized Fields

aPNSVoipSandboxChannelResponse

APNSVoipSandboxChannelResponse aPNSVoipSandboxChannelResponse

Apple VoIP Developer Push Notification Service channel definition.

Class com.amazonaws.services.pinpoint.model.UpdateApplicationSettingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

writeApplicationSettingsRequest

WriteApplicationSettingsRequest writeApplicationSettingsRequest

Creating application setting request

Class com.amazonaws.services.pinpoint.model.UpdateApplicationSettingsResult extends java.lang.Object implements Serializable

Serialized Fields

applicationSettingsResource

ApplicationSettingsResource applicationSettingsResource

Application settings.

Class com.amazonaws.services.pinpoint.model.UpdateAttributesRequest extends java.lang.Object implements Serializable

Serialized Fields

blacklist

java.util.List<java.lang.String> blacklist

The GLOB wildcard for removing the attributes in the application

Class com.amazonaws.services.pinpoint.model.UpdateBaiduChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

baiduChannelRequest

BaiduChannelRequest baiduChannelRequest

Baidu Cloud Push credentials

Class com.amazonaws.services.pinpoint.model.UpdateBaiduChannelResult extends java.lang.Object implements Serializable

Serialized Fields

baiduChannelResponse

BaiduChannelResponse baiduChannelResponse

Baidu Cloud Messaging channel definition

Class com.amazonaws.services.pinpoint.model.UpdateCampaignRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

campaignId

java.lang.String campaignId

The unique ID of the campaign.

writeCampaignRequest

WriteCampaignRequest writeCampaignRequest

Used to create a campaign.

Class com.amazonaws.services.pinpoint.model.UpdateCampaignResult extends java.lang.Object implements Serializable

Serialized Fields

campaignResponse

CampaignResponse campaignResponse

Campaign definition

Class com.amazonaws.services.pinpoint.model.UpdateEmailChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

emailChannelRequest

EmailChannelRequest emailChannelRequest

Email Channel Request

Class com.amazonaws.services.pinpoint.model.UpdateEmailChannelResult extends java.lang.Object implements Serializable

Serialized Fields

emailChannelResponse

EmailChannelResponse emailChannelResponse

Email Channel Response.

Class com.amazonaws.services.pinpoint.model.UpdateEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

endpointId

java.lang.String endpointId

The unique ID of the endpoint.

endpointRequest

EndpointRequest endpointRequest

An endpoint update request.

Class com.amazonaws.services.pinpoint.model.UpdateEndpointResult extends java.lang.Object implements Serializable

Serialized Fields

messageBody

MessageBody messageBody

Simple message object.

Class com.amazonaws.services.pinpoint.model.UpdateEndpointsBatchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

endpointBatchRequest

EndpointBatchRequest endpointBatchRequest

Endpoint batch update request.

Class com.amazonaws.services.pinpoint.model.UpdateEndpointsBatchResult extends java.lang.Object implements Serializable

Serialized Fields

messageBody

MessageBody messageBody

Simple message object.

Class com.amazonaws.services.pinpoint.model.UpdateGcmChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

gCMChannelRequest

GCMChannelRequest gCMChannelRequest

Google Cloud Messaging credentials

Class com.amazonaws.services.pinpoint.model.UpdateGcmChannelResult extends java.lang.Object implements Serializable

Serialized Fields

gCMChannelResponse

GCMChannelResponse gCMChannelResponse

Google Cloud Messaging channel definition

Class com.amazonaws.services.pinpoint.model.UpdateSegmentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

segmentId

java.lang.String segmentId

The unique ID of the segment.

writeSegmentRequest

WriteSegmentRequest writeSegmentRequest

Segment definition.

Class com.amazonaws.services.pinpoint.model.UpdateSegmentResult extends java.lang.Object implements Serializable

Serialized Fields

segmentResponse

SegmentResponse segmentResponse

Segment definition.

Class com.amazonaws.services.pinpoint.model.UpdateSmsChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

sMSChannelRequest

SMSChannelRequest sMSChannelRequest

SMS Channel Request

Class com.amazonaws.services.pinpoint.model.UpdateSmsChannelResult extends java.lang.Object implements Serializable

Serialized Fields

sMSChannelResponse

SMSChannelResponse sMSChannelResponse

SMS Channel Response.

Class com.amazonaws.services.pinpoint.model.UpdateVoiceChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

The unique ID of your Amazon Pinpoint application.

voiceChannelRequest

VoiceChannelRequest voiceChannelRequest

Voice Channel Request

Class com.amazonaws.services.pinpoint.model.UpdateVoiceChannelResult extends java.lang.Object implements Serializable

Serialized Fields

voiceChannelResponse

VoiceChannelResponse voiceChannelResponse

Voice Channel Response.

Class com.amazonaws.services.pinpoint.model.VoiceChannelRequest extends java.lang.Object implements Serializable

Serialized Fields

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

Class com.amazonaws.services.pinpoint.model.VoiceChannelResponse extends java.lang.Object implements Serializable

Serialized Fields

applicationId

java.lang.String applicationId

Application id

creationDate

java.lang.String creationDate

The date that the settings were last updated in ISO 8601 format.

enabled

java.lang.Boolean enabled

If the channel is enabled for sending messages.

hasCredential

java.lang.Boolean hasCredential

The new value for the hasCredential property for this object.

id

java.lang.String id

Channel ID. Not used, only for backwards compatibility.

isArchived

java.lang.Boolean isArchived

Is this channel archived

lastModifiedBy

java.lang.String lastModifiedBy

Who made the last change

lastModifiedDate

java.lang.String lastModifiedDate

Last date this was updated

platform

java.lang.String platform

Platform type. Will be "Voice"

version

java.lang.Integer version

Version of channel

Class com.amazonaws.services.pinpoint.model.VoiceMessage extends java.lang.Object implements Serializable

Serialized Fields

body

java.lang.String body

The message body of the notification, the email body or the text message.

languageCode

java.lang.String languageCode

Language of sent message

originationNumber

java.lang.String originationNumber

Is the number from the pool or messaging service to send from.

substitutions

java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions

Default message substitutions. Can be overridden by individual address substitutions.

voiceId

java.lang.String voiceId

Voice ID of sent message.

Class com.amazonaws.services.pinpoint.model.WriteApplicationSettingsRequest extends java.lang.Object implements Serializable

Serialized Fields

campaignHook

CampaignHook campaignHook

Default campaign hook information.

cloudWatchMetricsEnabled

java.lang.Boolean cloudWatchMetricsEnabled

The CloudWatchMetrics settings for the app.

limits

CampaignLimits limits

The limits that apply to each campaign in the project by default. Campaigns can also have their own limits, which override the settings at the project level.

quietTime

QuietTime quietTime

The default quiet time for the app. Campaigns in the app don't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your app. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up an app to use quiet time, campaigns in that app don't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the app (or campaign, if applicable). - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the app (or campaign, if applicable). Individual campaigns within the app can have their own quiet time settings, which override the quiet time settings at the app level.

Class com.amazonaws.services.pinpoint.model.WriteCampaignRequest extends java.lang.Object implements Serializable

Serialized Fields

additionalTreatments

java.util.List<WriteTreatmentResource> additionalTreatments

Treatments that are defined in addition to the default treatment.

description

java.lang.String description

A description of the campaign.

holdoutPercent

java.lang.Integer holdoutPercent

The allocated percentage of end users who will not receive messages from this campaign.

hook

CampaignHook hook

Campaign hook information.

isPaused

java.lang.Boolean isPaused

Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.

limits

CampaignLimits limits

The campaign limits settings.

messageConfiguration

MessageConfiguration messageConfiguration

The message configuration settings.

name

java.lang.String name

The custom name of the campaign.

schedule

Schedule schedule

The campaign schedule.

segmentId

java.lang.String segmentId

The ID of the segment to which the campaign sends messages.

segmentVersion

java.lang.Integer segmentVersion

The version of the segment to which the campaign sends messages.

treatmentDescription

java.lang.String treatmentDescription

A custom description for the treatment.

treatmentName

java.lang.String treatmentName

The custom name of a variation of the campaign used for A/B testing.

Class com.amazonaws.services.pinpoint.model.WriteEventStream extends java.lang.Object implements Serializable

Serialized Fields

destinationStreamArn

java.lang.String destinationStreamArn

The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME

roleArn

java.lang.String roleArn

The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

Class com.amazonaws.services.pinpoint.model.WriteSegmentRequest extends java.lang.Object implements Serializable

Serialized Fields

dimensions

SegmentDimensions dimensions

The segment dimensions attributes.

name

java.lang.String name

The name of segment

segmentGroups

SegmentGroupList segmentGroups

A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments. Your request can only include one segment group. Your request can include either a SegmentGroups object or a Dimensions object, but not both.

Class com.amazonaws.services.pinpoint.model.WriteTreatmentResource extends java.lang.Object implements Serializable

Serialized Fields

messageConfiguration

MessageConfiguration messageConfiguration

The message configuration settings.

schedule

Schedule schedule

The campaign schedule.

sizePercent

java.lang.Integer sizePercent

The allocated percentage of users for this treatment.

treatmentDescription

java.lang.String treatmentDescription

A custom description for the treatment.

treatmentName

java.lang.String treatmentName

The custom name of a variation of the campaign used for A/B testing.

Package com.amazonaws.services.pinpointanalytics.model

Class com.amazonaws.services.pinpointanalytics.model.BadRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.pinpointanalytics.model.Event extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

A collection of key-value pairs that give additional context to the event. The key-value pairs are specified by the developer.

This collection can be empty or the attribute object can be omitted.

eventType

java.lang.String eventType

A name signifying an event that occurred in your app. This is used for grouping and aggregating like events together for reporting purposes.

Constraints:
Length: 1 - 50

metrics

java.util.Map<java.lang.String,java.lang.Double> metrics

A collection of key-value pairs that gives additional, measurable context to the event. The key-value pairs are specified by the developer.

This collection can be empty or the attribute object can be omitted.

session

Session session

The session the event occured within.

timestamp

java.lang.String timestamp

The time the event occurred in ISO 8601 standard date time format. For example, 2014-06-30T19:07:47.885Z

version

java.lang.String version

The version of the event.

Constraints:
Length: 1 - 10

Class com.amazonaws.services.pinpointanalytics.model.PutEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientContext

java.lang.String clientContext

The client context including the client ID, app title, app version and package name.

clientContextEncoding

java.lang.String clientContextEncoding

The encoding used for the client context.

events

java.util.List<Event> events

An array of Event JSON objects

Class com.amazonaws.services.pinpointanalytics.model.Session extends java.lang.Object implements Serializable

Serialized Fields

duration

java.lang.Long duration

The duration of the session.

id

java.lang.String id

A unique identifier for the session

Constraints:
Length: 1 - 50

startTimestamp

java.lang.String startTimestamp

The time the event started in ISO 8601 standard date time format. For example, 2014-06-30T19:07:47.885Z

stopTimestamp

java.lang.String stopTimestamp

The time the event terminated in ISO 8601 standard date time format. For example, 2014-06-30T19:07:47.885Z

Package com.amazonaws.services.polly.model

Class com.amazonaws.services.polly.model.DeleteLexiconRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

java.lang.String name

The name of the lexicon to delete. Must be an existing lexicon in the region.

Constraints:
Pattern: [0-9A-Za-z]{1,20}

Class com.amazonaws.services.polly.model.DeleteLexiconResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.polly.model.DescribeVoicesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

engine

java.lang.String engine

Specifies the engine (standard or neural) used by Amazon Polly when processing input text for speech synthesis.

Constraints:
Allowed Values: standard, neural

includeAdditionalLanguageCodes

java.lang.Boolean includeAdditionalLanguageCodes

Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but not if you specify no.

languageCode

java.lang.String languageCode

The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT

nextToken

java.lang.String nextToken

An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.

Constraints:
Length: 0 - 4096

Class com.amazonaws.services.polly.model.DescribeVoicesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The pagination token to use in the next request to continue the listing of voices. NextToken is returned only if the response is truncated.

Constraints:
Length: 0 - 4096

voices

java.util.List<Voice> voices

A list of voices with their properties.

Class com.amazonaws.services.polly.model.EngineNotSupportedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.GetLexiconRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

java.lang.String name

Name of the lexicon.

Constraints:
Pattern: [0-9A-Za-z]{1,20}

Class com.amazonaws.services.polly.model.GetLexiconResult extends java.lang.Object implements Serializable

Serialized Fields

lexicon

Lexicon lexicon

Lexicon object that provides name and the string content of the lexicon.

lexiconAttributes

LexiconAttributes lexiconAttributes

Metadata of the lexicon, including phonetic alphabetic used, language code, lexicon ARN, number of lexemes defined in the lexicon, and size of lexicon in bytes.

Class com.amazonaws.services.polly.model.GetSpeechSynthesisTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskId

java.lang.String taskId

The Amazon Polly generated identifier for a speech synthesis task.

Constraints:
Pattern: ^[a-zA-Z0-9_-]{1,100}$

Class com.amazonaws.services.polly.model.GetSpeechSynthesisTaskResult extends java.lang.Object implements Serializable

Serialized Fields

synthesisTask

SynthesisTask synthesisTask

SynthesisTask object that provides information from the requested task, including output format, creation time, task status, and so on.

Class com.amazonaws.services.polly.model.InvalidLexiconException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.InvalidNextTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.InvalidS3BucketException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.InvalidS3KeyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.InvalidSampleRateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.InvalidSnsTopicArnException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.InvalidSsmlException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.InvalidTaskIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.LanguageNotSupportedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.Lexicon extends java.lang.Object implements Serializable

Serialized Fields

content

java.lang.String content

Lexicon content in string format. The content of a lexicon must be in PLS format.

name

java.lang.String name

Name of the lexicon.

Constraints:
Pattern: [0-9A-Za-z]{1,20}

Class com.amazonaws.services.polly.model.LexiconAttributes extends java.lang.Object implements Serializable

Serialized Fields

alphabet

java.lang.String alphabet

Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa.

languageCode

java.lang.String languageCode

Language code that the lexicon applies to. A lexicon with a language code such as "en" would be applied to all English languages (en-GB, en-US, en-AUS, en-WLS, and so on.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT

lastModified

java.util.Date lastModified

Date lexicon was last modified (a timestamp value).

lexemesCount

java.lang.Integer lexemesCount

Number of lexemes in the lexicon.

lexiconArn

java.lang.String lexiconArn

Amazon Resource Name (ARN) of the lexicon.

size

java.lang.Integer size

Total size of the lexicon, in characters.

Class com.amazonaws.services.polly.model.LexiconDescription extends java.lang.Object implements Serializable

Serialized Fields

attributes

LexiconAttributes attributes

Provides lexicon metadata.

name

java.lang.String name

Name of the lexicon.

Constraints:
Pattern: [0-9A-Za-z]{1,20}

Class com.amazonaws.services.polly.model.LexiconNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.LexiconSizeExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.ListLexiconsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

An opaque pagination token returned from previous ListLexicons operation. If present, indicates where to continue the list of lexicons.

Constraints:
Length: 0 - 4096

Class com.amazonaws.services.polly.model.ListLexiconsResult extends java.lang.Object implements Serializable

Serialized Fields

lexicons

java.util.List<LexiconDescription> lexicons

A list of lexicon names and attributes.

nextToken

java.lang.String nextToken

The pagination token to use in the next request to continue the listing of lexicons. NextToken is returned only if the response is truncated.

Constraints:
Length: 0 - 4096

Class com.amazonaws.services.polly.model.ListSpeechSynthesisTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

Maximum number of speech synthesis tasks returned in a List operation.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

The pagination token to use in the next request to continue the listing of speech synthesis tasks.

Constraints:
Length: 0 - 4096

status

java.lang.String status

Status of the speech synthesis tasks returned in a List operation

Constraints:
Allowed Values: scheduled, inProgress, completed, failed

Class com.amazonaws.services.polly.model.ListSpeechSynthesisTasksResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

An opaque pagination token returned from the previous List operation in this request. If present, this indicates where to continue the listing.

Constraints:
Length: 0 - 4096

synthesisTasks

java.util.List<SynthesisTask> synthesisTasks

List of SynthesisTask objects that provides information from the specified task in the list request, including output format, creation time, task status, and so on.

Class com.amazonaws.services.polly.model.MarksNotSupportedForFormatException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.MaxLexemeLengthExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.MaxLexiconsNumberExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.PutLexiconRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

content

java.lang.String content

Content of the PLS lexicon as string data.

name

java.lang.String name

Name of the lexicon. The name must follow the regular express format [0-9A-Za-z]{1,20}. That is, the name is a case-sensitive alphanumeric string up to 20 characters long.

Constraints:
Pattern: [0-9A-Za-z]{1,20}

Class com.amazonaws.services.polly.model.PutLexiconResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.polly.model.ServiceFailureException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.SsmlMarksNotSupportedForTextTypeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.StartSpeechSynthesisTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

engine

java.lang.String engine

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

Constraints:
Allowed Values: standard, neural

languageCode

java.lang.String languageCode

Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT

lexiconNames

java.util.List<java.lang.String> lexiconNames

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.

outputFormat

java.lang.String outputFormat

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

Constraints:
Allowed Values: json, mp3, ogg_vorbis, pcm

outputS3BucketName

java.lang.String outputS3BucketName

Amazon S3 bucket name to which the output file will be saved.

Constraints:
Pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$

outputS3KeyPrefix

java.lang.String outputS3KeyPrefix

The Amazon S3 key prefix for the output speech file.

Constraints:
Pattern: ^[0-9a-zA-Z\/\!\-_\.\*\'\(\):;\$@=+\,\?&]{0,800}$

sampleRate

java.lang.String sampleRate

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".

Valid values for pcm are "8000" and "16000" The default value is "16000".

snsTopicArn

java.lang.String snsTopicArn

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Constraints:
Pattern: ^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:[a-z0- 9_-]{1,50}:\d{12}:[a-zA-Z0-9_-]{1,256}$

speechMarkTypes

java.util.List<java.lang.String> speechMarkTypes

The type of speech marks returned for the input text.

text

java.lang.String text

The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

textType

java.lang.String textType

Specifies whether the input text is plain text or SSML. The default value is plain text.

Constraints:
Allowed Values: ssml, text

voiceId

java.lang.String voiceId

Voice ID to use for the synthesis.

Constraints:
Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal

Class com.amazonaws.services.polly.model.StartSpeechSynthesisTaskResult extends java.lang.Object implements Serializable

Serialized Fields

synthesisTask

SynthesisTask synthesisTask

SynthesisTask object that provides information and attributes about a newly submitted speech synthesis task.

Class com.amazonaws.services.polly.model.SynthesisTask extends java.lang.Object implements Serializable

Serialized Fields

creationTime

java.util.Date creationTime

Timestamp for the time the synthesis task was started.

engine

java.lang.String engine

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

Constraints:
Allowed Values: standard, neural

languageCode

java.lang.String languageCode

Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT

lexiconNames

java.util.List<java.lang.String> lexiconNames

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.

outputFormat

java.lang.String outputFormat

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

Constraints:
Allowed Values: json, mp3, ogg_vorbis, pcm

outputUri

java.lang.String outputUri

Pathway for the output speech file.

requestCharacters

java.lang.Integer requestCharacters

Number of billable characters synthesized.

sampleRate

java.lang.String sampleRate

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".

Valid values for pcm are "8000" and "16000" The default value is "16000".

snsTopicArn

java.lang.String snsTopicArn

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Constraints:
Pattern: ^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:[a-z0- 9_-]{1,50}:\d{12}:[a-zA-Z0-9_-]{1,256}$

speechMarkTypes

java.util.List<java.lang.String> speechMarkTypes

The type of speech marks returned for the input text.

taskId

java.lang.String taskId

The Amazon Polly generated identifier for a speech synthesis task.

Constraints:
Pattern: ^[a-zA-Z0-9_-]{1,100}$

taskStatus

java.lang.String taskStatus

Current status of the individual speech synthesis task.

Constraints:
Allowed Values: scheduled, inProgress, completed, failed

taskStatusReason

java.lang.String taskStatusReason

Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

textType

java.lang.String textType

Specifies whether the input text is plain text or SSML. The default value is plain text.

Constraints:
Allowed Values: ssml, text

voiceId

java.lang.String voiceId

Voice ID to use for the synthesis.

Constraints:
Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal

Class com.amazonaws.services.polly.model.SynthesisTaskNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.SynthesizeSpeechPresignRequest extends java.lang.Object implements Serializable

Serialized Fields

credentials

AWSCredentials credentials

The optional credentials to use for this request - overrides the default credentials set at the client level.

engine

Engine engine

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

expiration

java.util.Date expiration

An optional expiration date at which point the generated pre-signed URL will no longer be accepted by Amazon Polly. If not specified, a default value will be supplied, calculated as 15 minutes from getting the pre-signed URL.

languageCode

java.lang.String languageCode

Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

Constraints:
Allowed Values: cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR

lexiconNames

java.util.List<java.lang.String> lexiconNames

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see PutLexicon.

outputFormat

java.lang.String outputFormat

The audio format in which the resulting stream will be encoded.

Constraints:
Allowed Values: mp3, ogg_vorbis, pcm

sampleRate

java.lang.String sampleRate

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", and "22050". The default value is "22050".

Valid values for pcm are "8000" and "16000" The default value is "16000".

speechMarkTypes

java.util.List<java.lang.String> speechMarkTypes

The new value for the speechMarkTypes property for this object.

text

java.lang.String text

Input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

textType

java.lang.String textType

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

Constraints:
Allowed Values: ssml, text

voiceId

java.lang.String voiceId

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

Constraints:
Allowed Values: Geraint, Gwyneth, Mads, Naja, Hans, Marlene, Nicole, Russell, Amy, Brian, Emma, Raveena, Ivy, Joanna, Joey, Justin, Kendra, Kimberly, Matthew, Salli, Conchita, Enrique, Miguel, Penelope, Chantal, Celine, Mathieu, Dora, Karl, Carla, Giorgio, Mizuki, Liv, Lotte, Ruben, Ewa, Jacek, Jan, Maja, Ricardo, Vitoria, Cristiano, Ines, Carmen, Maxim, Tatyana, Astrid, Filiz, Vicki, Takumi, Seoyeon, Aditi, Lea, Zhiyu, Bianca, Lucia, Mia

Class com.amazonaws.services.polly.model.SynthesizeSpeechRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

engine

java.lang.String engine

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available in standard-only, NTTS-only, and both standard and NTTS formats, see Available Voices.

NTTS-only voices

When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.

Type: String

Valid Values: standard | neural

Required: Yes

Standard voices

For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.

Constraints:
Allowed Values: standard, neural

languageCode

java.lang.String languageCode

Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT

lexiconNames

java.util.List<java.lang.String> lexiconNames

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see PutLexicon.

outputFormat

java.lang.String outputFormat

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

Constraints:
Allowed Values: json, mp3, ogg_vorbis, pcm

sampleRate

java.lang.String sampleRate

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".

Valid values for pcm are "8000" and "16000" The default value is "16000".

speechMarkTypes

java.util.List<java.lang.String> speechMarkTypes

The type of speech marks returned for the input text.

text

java.lang.String text

Input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

textType

java.lang.String textType

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

Constraints:
Allowed Values: ssml, text

voiceId

java.lang.String voiceId

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

Constraints:
Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal

Class com.amazonaws.services.polly.model.SynthesizeSpeechResult extends java.lang.Object implements Serializable

Serialized Fields

audioStream

java.io.InputStream audioStream

Stream containing the synthesized speech.

contentType

java.lang.String contentType

Specifies the type audio stream. This should reflect the OutputFormat parameter in your request.

• If you request mp3 as the OutputFormat, the ContentType returned is audio/mpeg.

• If you request ogg_vorbis as the OutputFormat, the ContentType returned is audio/ogg.

• If you request pcm as the OutputFormat, the ContentType returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

• If you request json as the OutputFormat, the ContentType returned is application/x-json-stream.

requestCharacters

java.lang.Integer requestCharacters

Number of characters synthesized.

Class com.amazonaws.services.polly.model.TextLengthExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.UnsupportedPlsAlphabetException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.UnsupportedPlsLanguageException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.polly.model.Voice extends java.lang.Object implements Serializable

Serialized Fields

additionalLanguageCodes

java.util.List<java.lang.String> additionalLanguageCodes

Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

gender

java.lang.String gender

Gender of the voice.

Constraints:
Allowed Values: Female, Male

id

java.lang.String id

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

Constraints:
Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal

languageCode

java.lang.String languageCode

Language code of the voice.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT

languageName

java.lang.String languageName

Human readable name of the language in English.

name

java.lang.String name

Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

supportedEngines

java.util.List<java.lang.String> supportedEngines

Specifies which engines (standard or neural) that are supported by a given voice.

Package com.amazonaws.services.rekognition.model

Class com.amazonaws.services.rekognition.model.AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.AgeRange extends java.lang.Object implements Serializable

Serialized Fields

high

java.lang.Integer high

The highest estimated age.

Constraints:
Range: 0 -

low

java.lang.Integer low

The lowest estimated age.

Constraints:
Range: 0 -

Class com.amazonaws.services.rekognition.model.Asset extends java.lang.Object implements Serializable

Serialized Fields

groundTruthManifest

GroundTruthManifest groundTruthManifest

The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

Class com.amazonaws.services.rekognition.model.AudioMetadata extends java.lang.Object implements Serializable

Serialized Fields

codec

java.lang.String codec

The audio codec used to encode or decode the audio stream.

durationMillis

java.lang.Long durationMillis

The duration of the audio stream in milliseconds.

Constraints:
Range: 0 -

numberOfChannels

java.lang.Long numberOfChannels

The number of audio channels in the segment.

Constraints:
Range: 0 -

sampleRate

java.lang.Long sampleRate

The sample rate for the audio stream.

Constraints:
Range: 0 -

Class com.amazonaws.services.rekognition.model.Beard extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

Level of confidence in the determination.

Constraints:
Length: 0.0 - 100.0

value

java.lang.Boolean value

Boolean value that indicates whether the face has beard or not.

Class com.amazonaws.services.rekognition.model.BlackFrame extends java.lang.Object implements Serializable

Serialized Fields

maxPixelThreshold

java.lang.Float maxPixelThreshold

A threshold used to determine the maximum luminance value for a pixel to be considered black. In a full color range video, luminance values range from 0-255. A pixel value of 0 is pure black, and the most strict filter. The maximum black pixel value is computed as follows: max_black_pixel_value = minimum_luminance + MaxPixelThreshold *luminance_range.

For example, for a full range video with BlackPixelThreshold = 0.1, max_black_pixel_value is 0 + 0.1 * (255-0) = 25.5.

The default value of MaxPixelThreshold is 0.2, which maps to a max_black_pixel_value of 51 for a full range video. You can lower this threshold to be more strict on black levels.

Constraints:
Length: 0.0 - 1.0

minCoveragePercentage

java.lang.Float minCoveragePercentage

The minimum percentage of pixels in a frame that need to have a luminance below the max_black_pixel_value for a frame to be considered a black frame. Luminance is calculated using the BT.709 matrix.

The default value is 99, which means at least 99% of all pixels in the frame are black pixels as per the MaxPixelThreshold set. You can reduce this value to allow more noise on the black frame.

Constraints:
Length: 0.0 - 100.0

Class com.amazonaws.services.rekognition.model.BoundingBox extends java.lang.Object implements Serializable

Serialized Fields

height

java.lang.Float height

Height of the bounding box as a ratio of the overall image height.

left

java.lang.Float left

Left coordinate of the bounding box as a ratio of overall image width.

top

java.lang.Float top

Top coordinate of the bounding box as a ratio of overall image height.

width

java.lang.Float width

Width of the bounding box as a ratio of the overall image width.

Class com.amazonaws.services.rekognition.model.Celebrity extends java.lang.Object implements Serializable

Serialized Fields

face

ComparedFace face

Provides information about the celebrity's face, such as its location on the image.

id

java.lang.String id

A unique identifier for the celebrity.

Constraints:
Pattern: [0-9A-Za-z]*

knownGender

KnownGender knownGender

The known gender identity for the celebrity that matches the provided ID. The known gender identity can be Male, Female, Nonbinary, or Unlisted.

matchConfidence

java.lang.Float matchConfidence

The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.

Constraints:
Length: 0.0 - 100.0

name

java.lang.String name

The name of the celebrity.

urls

java.util.List<java.lang.String> urls

An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.

Class com.amazonaws.services.rekognition.model.CelebrityDetail extends java.lang.Object implements Serializable

Serialized Fields

boundingBox

BoundingBox boundingBox

Bounding box around the body of a celebrity.

confidence

java.lang.Float confidence

The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.

Constraints:
Length: 0.0 - 100.0

face

FaceDetail face

Face details for the recognized celebrity.

id

java.lang.String id

The unique identifier for the celebrity.

Constraints:
Pattern: [0-9A-Za-z]*

knownGender

KnownGender knownGender

Retrieves the known gender for the celebrity.

name

java.lang.String name

The name of the celebrity.

urls

java.util.List<java.lang.String> urls

An array of URLs pointing to additional celebrity information.

Class com.amazonaws.services.rekognition.model.CelebrityRecognition extends java.lang.Object implements Serializable

Serialized Fields

celebrity

CelebrityDetail celebrity

Information about a recognized celebrity.

timestamp

java.lang.Long timestamp

The time, in milliseconds from the start of the video, that the celebrity was recognized.

Class com.amazonaws.services.rekognition.model.ComparedFace extends java.lang.Object implements Serializable

Serialized Fields

boundingBox

BoundingBox boundingBox

Bounding box of the face.

confidence

java.lang.Float confidence

Level of confidence that what the bounding box contains is a face.

Constraints:
Length: 0.0 - 100.0

emotions

java.util.List<Emotion> emotions

The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".

landmarks

java.util.List<Landmark> landmarks

An array of facial landmarks.

pose

Pose pose

Indicates the pose of the face as determined by its pitch, roll, and yaw.

quality

ImageQuality quality

Identifies face image brightness and sharpness.

smile

Smile smile

Indicates whether or not the face is smiling, and the confidence level in the determination.

Class com.amazonaws.services.rekognition.model.ComparedSourceImageFace extends java.lang.Object implements Serializable

Serialized Fields

boundingBox

BoundingBox boundingBox

Bounding box of the face.

confidence

java.lang.Float confidence

Confidence level that the selected bounding box contains a face.

Constraints:
Length: 0.0 - 100.0

Class com.amazonaws.services.rekognition.model.CompareFacesMatch extends java.lang.Object implements Serializable

Serialized Fields

face

ComparedFace face

Provides face metadata (bounding box and confidence that the bounding box actually contains a face).

similarity

java.lang.Float similarity

Level of confidence that the faces match.

Constraints:
Length: 0.0 - 100.0

Class com.amazonaws.services.rekognition.model.CompareFacesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

qualityFilter

java.lang.String qualityFilter

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

Constraints:
Allowed Values: NONE, AUTO, LOW, MEDIUM, HIGH

similarityThreshold

java.lang.Float similarityThreshold

The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.

Constraints:
Length: 0.0 - 100.0

sourceImage

Image sourceImage

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

targetImage

Image targetImage

The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Class com.amazonaws.services.rekognition.model.CompareFacesResult extends java.lang.Object implements Serializable

Serialized Fields

faceMatches

java.util.List<CompareFacesMatch> faceMatches

An array of faces in the target image that match the source image face. Each CompareFacesMatch object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.

sourceImageFace

ComparedSourceImageFace sourceImageFace

The face in the source image that was used for comparison.

sourceImageOrientationCorrection

java.lang.String sourceImageOrientationCorrection

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

targetImageOrientationCorrection

java.lang.String targetImageOrientationCorrection

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

unmatchedFaces

java.util.List<ComparedFace> unmatchedFaces

An array of faces in the target image that did not match the source image face.

Class com.amazonaws.services.rekognition.model.ConnectedHomeSettings extends java.lang.Object implements Serializable

Serialized Fields

labels

java.util.List<java.lang.String> labels

Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: "PERSON", "PET", "PACKAGE", and "ALL".

minConfidence

java.lang.Float minConfidence

The minimum confidence required to label an object in the video.

Constraints:
Length: 0.0 - 100.0

Class com.amazonaws.services.rekognition.model.ConnectedHomeSettingsForUpdate extends java.lang.Object implements Serializable

Serialized Fields

labels

java.util.List<java.lang.String> labels

Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: "PERSON", "PET", "PACKAGE", and "ALL".

minConfidence

java.lang.Float minConfidence

The minimum confidence required to label an object in the video.

Constraints:
Length: 0.0 - 100.0

Class com.amazonaws.services.rekognition.model.ContentModerationDetection extends java.lang.Object implements Serializable

Serialized Fields

moderationLabel

ModerationLabel moderationLabel

The content moderation label detected by in the stored video.

timestamp

java.lang.Long timestamp

Time, in milliseconds from the beginning of the video, that the content moderation label was detected.

Class com.amazonaws.services.rekognition.model.CopyProjectVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationProjectArn

java.lang.String destinationProjectArn

The ARN of the project in the trusted AWS account that you want to copy the model version to.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/[0-9]+$)

kmsKeyId

java.lang.String kmsKeyId

The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training results and manifest files written to the output Amazon S3 bucket (OutputConfig).

If you choose to use your own KMS key, you need the following permissions on the KMS key.

• kms:CreateGrant

• kms:DescribeKey

• kms:GenerateDataKey

• kms:Decrypt

If you don't specify a value for KmsKeyId, images copied into the service are encrypted using a key that AWS owns and manages.

Constraints:
Length: 1 - 2048
Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

outputConfig

OutputConfig outputConfig

The S3 bucket and folder location where the training output for the source model version is placed.

sourceProjectArn

java.lang.String sourceProjectArn

The ARN of the source project in the trusting AWS account.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/[0-9]+$)

sourceProjectVersionArn

java.lang.String sourceProjectVersionArn

The ARN of the model version in the source project that you want to copy to a destination project.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/version\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)

tags

java.util.Map<java.lang.String,java.lang.String> tags

The key-value tags to assign to the model version.

versionName

java.lang.String versionName

A name for the version of the model that's copied to the destination project.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

Class com.amazonaws.services.rekognition.model.CopyProjectVersionResult extends java.lang.Object implements Serializable

Serialized Fields

projectVersionArn

java.lang.String projectVersionArn

The ARN of the copied model version in the destination project.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/version\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.CoversBodyPart extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

The confidence that Amazon Rekognition has in the value of Value.

Constraints:
Length: 0.0 - 100.0

value

java.lang.Boolean value

True if the PPE covers the corresponding body part, otherwise false.

Class com.amazonaws.services.rekognition.model.CreateCollectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionId

java.lang.String collectionId

ID for the collection that you are creating.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

tags

java.util.Map<java.lang.String,java.lang.String> tags

A set of tags (key-value pairs) that you want to attach to the collection.

Class com.amazonaws.services.rekognition.model.CreateCollectionResult extends java.lang.Object implements Serializable

Serialized Fields

collectionArn

java.lang.String collectionArn

Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources.

faceModelVersion

java.lang.String faceModelVersion

Version number of the face detection model associated with the collection you are creating.

statusCode

java.lang.Integer statusCode

HTTP status code indicating the result of the operation.

Constraints:
Range: 0 -

Class com.amazonaws.services.rekognition.model.CreateDatasetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

datasetSource

DatasetSource datasetSource

The source files for the dataset. You can specify the ARN of an existing dataset or specify the Amazon S3 bucket location of an Amazon Sagemaker format manifest file. If you don't specify datasetSource, an empty dataset is created. To add labeled images to the dataset, You can use the console or call UpdateDatasetEntries.

datasetType

java.lang.String datasetType

The type of the dataset. Specify train to create a training dataset. Specify test to create a test dataset.

Constraints:
Allowed Values: TRAIN, TEST

projectArn

java.lang.String projectArn

The ARN of the Amazon Rekognition Custom Labels project to which you want to asssign the dataset.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.CreateDatasetResult extends java.lang.Object implements Serializable

Serialized Fields

datasetArn

java.lang.String datasetArn

The ARN of the created Amazon Rekognition Custom Labels dataset.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/dataset\/(train|test)\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.CreateProjectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

projectName

java.lang.String projectName

The name of the project to create.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

Class com.amazonaws.services.rekognition.model.CreateProjectResult extends java.lang.Object implements Serializable

Serialized Fields

projectArn

java.lang.String projectArn

The Amazon Resource Name (ARN) of the new project. You can use the ARN to configure IAM access to the project.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.CreateProjectVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

kmsKeyId

java.lang.String kmsKeyId

The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. The key is also used to encrypt training results and manifest files written to the output Amazon S3 bucket (OutputConfig).

If you choose to use your own KMS key, you need the following permissions on the KMS key.

• kms:CreateGrant

• kms:DescribeKey

• kms:GenerateDataKey

• kms:Decrypt

If you don't specify a value for KmsKeyId, images copied into the service are encrypted using a key that AWS owns and manages.

Constraints:
Length: 1 - 2048
Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

outputConfig

OutputConfig outputConfig

The Amazon S3 bucket location to store the results of training. The S3 bucket can be in any AWS account as long as the caller has s3:PutObject permissions on the S3 bucket.

projectArn

java.lang.String projectArn

The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/[0-9]+$)

tags

java.util.Map<java.lang.String,java.lang.String> tags

A set of tags (key-value pairs) that you want to attach to the model.

testingData

TestingData testingData

Specifies an external manifest that the service uses to test the model. If you specify TestingData you must also specify TrainingData. The project must not have any associated datasets.

trainingData

TrainingData trainingData

Specifies an external manifest that the services uses to train the model. If you specify TrainingData you must also specify TestingData. The project must not have any associated datasets.

versionName

java.lang.String versionName

A name for the version of the model. This value must be unique.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

Class com.amazonaws.services.rekognition.model.CreateProjectVersionResult extends java.lang.Object implements Serializable

Serialized Fields

projectVersionArn

java.lang.String projectVersionArn

The ARN of the model version that was created. Use DescribeProjectVersion to get the current status of the training operation.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/version\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.CreateStreamProcessorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dataSharingPreference

StreamProcessorDataSharingPreference dataSharingPreference

Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams.

input

StreamProcessorInput input

Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput. This is required for both face search and label detection stream processors.

kmsKeyId

java.lang.String kmsKeyId

The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor. You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected.

Constraints:
Length: 1 - 2048
Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

name

java.lang.String name

An identifier you assign to the stream processor. You can use Name to manage the stream processor. For example, you can get the current status of the stream processor by calling DescribeStreamProcessor. Name is idempotent. This is required for both face search and label detection stream processors.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.\-]+

notificationChannel

StreamProcessorNotificationChannel notificationChannel

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.

Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications, one for a person at second 2 and one for a pet at second 4.

Amazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.

output

StreamProcessorOutput output

Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput. This must be a S3Destination of an Amazon S3 bucket that you own for a label detection stream processor or a Kinesis data stream ARN for a face search stream processor.

regionsOfInterest

java.util.List<RegionOfInterest> regionsOfInterest

Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest, and each region has either a polygon or a bounding box. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.

roleArn

java.lang.String roleArn

The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor. The IAM role provides Rekognition read permissions for a Kinesis stream. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a label detection stream processor. This is required for both face search and label detection stream processors.

Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

settings

StreamProcessorSettings settings

Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.

tags

java.util.Map<java.lang.String,java.lang.String> tags

A set of tags (key-value pairs) that you want to attach to the stream processor.

Class com.amazonaws.services.rekognition.model.CreateStreamProcessorResult extends java.lang.Object implements Serializable

Serialized Fields

streamProcessorArn

java.lang.String streamProcessorArn

Amazon Resource Number for the newly created stream processor.

Constraints:
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:streamprocessor\/.+$)

Class com.amazonaws.services.rekognition.model.CustomLabel extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

The confidence that the model has in the detection of the custom label. The range is 0-100. A higher value indicates a higher confidence.

Constraints:
Length: 0.0 - 100.0

geometry

Geometry geometry

The location of the detected object on the image that corresponds to the custom label. Includes an axis aligned coarse bounding box surrounding the object and a finer grain polygon for more accurate spatial information.

name

java.lang.String name

The name of the custom label.

Class com.amazonaws.services.rekognition.model.DatasetChanges extends java.lang.Object implements Serializable

Serialized Fields

groundTruth

java.nio.ByteBuffer groundTruth

A Base64-encoded binary data object containing one or JSON lines that either update the dataset or are additions to the dataset. You change a dataset by calling UpdateDatasetEntries. If you are using an AWS SDK to call UpdateDatasetEntries, you don't need to encode Changes as the SDK encodes the data for you.

For example JSON lines, see Image-Level labels in manifest files and and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.

Constraints:
Length: 1 - 5242880

Class com.amazonaws.services.rekognition.model.DatasetDescription extends java.lang.Object implements Serializable

Serialized Fields

creationTimestamp

java.util.Date creationTimestamp

The Unix timestamp for the time and date that the dataset was created.

datasetStats

DatasetStats datasetStats

The status message code for the dataset.

lastUpdatedTimestamp

java.util.Date lastUpdatedTimestamp

The Unix timestamp for the date and time that the dataset was last updated.

status

java.lang.String status

The status of the dataset.

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_COMPLETE, CREATE_FAILED, UPDATE_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_FAILED, DELETE_IN_PROGRESS

statusMessage

java.lang.String statusMessage

The status message for the dataset.

statusMessageCode

java.lang.String statusMessageCode

The status message code for the dataset operation. If a service error occurs, try the API call again later. If a client error occurs, check the input parameters to the dataset API call that failed.

Constraints:
Allowed Values: SUCCESS, SERVICE_ERROR, CLIENT_ERROR

Class com.amazonaws.services.rekognition.model.DatasetLabelDescription extends java.lang.Object implements Serializable

Serialized Fields

labelName

java.lang.String labelName

The name of the label.

Constraints:
Length: 1 - 255
Pattern: .{1,}

labelStats

DatasetLabelStats labelStats

Statistics about the label.

Class com.amazonaws.services.rekognition.model.DatasetLabelStats extends java.lang.Object implements Serializable

Serialized Fields

boundingBoxCount

java.lang.Integer boundingBoxCount

The total number of images that have the label assigned to a bounding box.

Constraints:
Range: 0 -

entryCount

java.lang.Integer entryCount

The total number of images that use the label.

Constraints:
Range: 0 -

Class com.amazonaws.services.rekognition.model.DatasetMetadata extends java.lang.Object implements Serializable

Serialized Fields

creationTimestamp

java.util.Date creationTimestamp

The Unix timestamp for the date and time that the dataset was created.

datasetArn

java.lang.String datasetArn

The Amazon Resource Name (ARN) for the dataset.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/dataset\/(train|test)\/[0-9]+$)

datasetType

java.lang.String datasetType

The type of the dataset.

Constraints:
Allowed Values: TRAIN, TEST

status

java.lang.String status

The status for the dataset.

Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_COMPLETE, CREATE_FAILED, UPDATE_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_FAILED, DELETE_IN_PROGRESS

statusMessage

java.lang.String statusMessage

The status message for the dataset.

statusMessageCode

java.lang.String statusMessageCode

The status message code for the dataset operation. If a service error occurs, try the API call again later. If a client error occurs, check the input parameters to the dataset API call that failed.

Constraints:
Allowed Values: SUCCESS, SERVICE_ERROR, CLIENT_ERROR

Class com.amazonaws.services.rekognition.model.DatasetSource extends java.lang.Object implements Serializable

Serialized Fields

datasetArn

java.lang.String datasetArn

The ARN of an Amazon Rekognition Custom Labels dataset that you want to copy.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/dataset\/(train|test)\/[0-9]+$)

groundTruthManifest

GroundTruthManifest groundTruthManifest

The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.

Class com.amazonaws.services.rekognition.model.DatasetStats extends java.lang.Object implements Serializable

Serialized Fields

errorEntries

java.lang.Integer errorEntries

The total number of entries that contain at least one error.

Constraints:
Range: 0 -

labeledEntries

java.lang.Integer labeledEntries

The total number of images in the dataset that have labels.

Constraints:
Range: 0 -

totalEntries

java.lang.Integer totalEntries

The total number of images in the dataset.

Constraints:
Range: 0 -

totalLabels

java.lang.Integer totalLabels

The total number of labels declared in the dataset.

Constraints:
Range: 0 -

Class com.amazonaws.services.rekognition.model.DeleteCollectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionId

java.lang.String collectionId

ID of the collection to delete.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

Class com.amazonaws.services.rekognition.model.DeleteCollectionResult extends java.lang.Object implements Serializable

Serialized Fields

statusCode

java.lang.Integer statusCode

HTTP status code that indicates the result of the operation.

Constraints:
Range: 0 -

Class com.amazonaws.services.rekognition.model.DeleteDatasetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

datasetArn

java.lang.String datasetArn

The ARN of the Amazon Rekognition Custom Labels dataset that you want to delete.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/dataset\/(train|test)\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.DeleteDatasetResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.rekognition.model.DeleteFacesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionId

java.lang.String collectionId

Collection from which to remove the specific faces.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

faceIds

java.util.List<java.lang.String> faceIds

An array of face IDs to delete.

Class com.amazonaws.services.rekognition.model.DeleteFacesResult extends java.lang.Object implements Serializable

Serialized Fields

deletedFaces

java.util.List<java.lang.String> deletedFaces

An array of strings (face IDs) of the faces that were deleted.

Class com.amazonaws.services.rekognition.model.DeleteProjectPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

java.lang.String policyName

The name of the policy that you want to delete.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.\-]+

policyRevisionId

java.lang.String policyRevisionId

The ID of the project policy revision that you want to delete.

Constraints:
Length: - 64
Pattern: [0-9A-Fa-f]+

projectArn

java.lang.String projectArn

The Amazon Resource Name (ARN) of the project that the project policy you want to delete is attached to.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.DeleteProjectPolicyResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.rekognition.model.DeleteProjectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

projectArn

java.lang.String projectArn

The Amazon Resource Name (ARN) of the project that you want to delete.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.DeleteProjectResult extends java.lang.Object implements Serializable

Serialized Fields

status

java.lang.String status

The current status of the delete project operation.

Constraints:
Allowed Values: CREATING, CREATED, DELETING

Class com.amazonaws.services.rekognition.model.DeleteProjectVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

projectVersionArn

java.lang.String projectVersionArn

The Amazon Resource Name (ARN) of the model version that you want to delete.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/version\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.DeleteProjectVersionResult extends java.lang.Object implements Serializable

Serialized Fields

status

java.lang.String status

The status of the deletion operation.

Constraints:
Allowed Values: TRAINING_IN_PROGRESS, TRAINING_COMPLETED, TRAINING_FAILED, STARTING, RUNNING, FAILED, STOPPING, STOPPED, DELETING, COPYING_IN_PROGRESS, COPYING_COMPLETED, COPYING_FAILED

Class com.amazonaws.services.rekognition.model.DeleteStreamProcessorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

java.lang.String name

The name of the stream processor you want to delete.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.\-]+

Class com.amazonaws.services.rekognition.model.DeleteStreamProcessorResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.rekognition.model.DescribeCollectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionId

java.lang.String collectionId

The ID of the collection to describe.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

Class com.amazonaws.services.rekognition.model.DescribeCollectionResult extends java.lang.Object implements Serializable

Serialized Fields

collectionARN

java.lang.String collectionARN

The Amazon Resource Name (ARN) of the collection.

creationTimestamp

java.util.Date creationTimestamp

The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.

faceCount

java.lang.Long faceCount

The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.

Constraints:
Range: 0 -

faceModelVersion

java.lang.String faceModelVersion

The version of the face model that's used by the collection for face detection.

For more information, see Model versioning in the Amazon Rekognition Developer Guide.

Class com.amazonaws.services.rekognition.model.DescribeDatasetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

datasetArn

java.lang.String datasetArn

The Amazon Resource Name (ARN) of the dataset that you want to describe.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/dataset\/(train|test)\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.DescribeDatasetResult extends java.lang.Object implements Serializable

Serialized Fields

datasetDescription

DatasetDescription datasetDescription

The description for the dataset.

Class com.amazonaws.services.rekognition.model.DescribeProjectsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Constraints:
Length: - 1024

projectNames

java.util.List<java.lang.String> projectNames

A list of the projects that you want Amazon Rekognition Custom Labels to describe. If you don't specify a value, the response includes descriptions for all the projects in your AWS account.

Class com.amazonaws.services.rekognition.model.DescribeProjectsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Constraints:
Length: - 1024

projectDescriptions

java.util.List<ProjectDescription> projectDescriptions

A list of project descriptions. The list is sorted by the date and time the projects are created.

Class com.amazonaws.services.rekognition.model.DescribeProjectVersionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Constraints:
Length: - 1024

projectArn

java.lang.String projectArn

The Amazon Resource Name (ARN) of the project that contains the models you want to describe.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/[0-9]+$)

versionNames

java.util.List<java.lang.String> versionNames

A list of model version names that you want to describe. You can add up to 10 model version names to the list. If you don't specify a value, all model descriptions are returned. A version name is part of a model (ProjectVersion) ARN. For example, my-model.2020-01-21T09.10.15 is the version name in the following ARN. arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123 .

Class com.amazonaws.services.rekognition.model.DescribeProjectVersionsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Constraints:
Length: - 1024

projectVersionDescriptions

java.util.List<ProjectVersionDescription> projectVersionDescriptions

A list of model descriptions. The list is sorted by the creation date and time of the model versions, latest to earliest.

Class com.amazonaws.services.rekognition.model.DescribeStreamProcessorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

java.lang.String name

Name of the stream processor for which you want information.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.\-]+

Class com.amazonaws.services.rekognition.model.DescribeStreamProcessorResult extends java.lang.Object implements Serializable

Serialized Fields

creationTimestamp

java.util.Date creationTimestamp

Date and time the stream processor was created

dataSharingPreference

StreamProcessorDataSharingPreference dataSharingPreference

Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams.

input

StreamProcessorInput input

Kinesis video stream that provides the source streaming video.

kmsKeyId

java.lang.String kmsKeyId

The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors.

Constraints:
Length: 1 - 2048
Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

lastUpdateTimestamp

java.util.Date lastUpdateTimestamp

The time, in Unix format, the stream processor was last updated. For example, when the stream processor moves from a running state to a failed state, or when the user starts or stops the stream processor.

name

java.lang.String name

Name of the stream processor.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.\-]+

notificationChannel

StreamProcessorNotificationChannel notificationChannel

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.

Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications, one for a person at second 2 and one for a pet at second 4.

Amazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.

output

StreamProcessorOutput output

Kinesis data stream to which Amazon Rekognition Video puts the analysis results.

regionsOfInterest

java.util.List<RegionOfInterest> regionsOfInterest

Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.

roleArn

java.lang.String roleArn

ARN of the IAM role that allows access to the stream processor.

Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

settings

StreamProcessorSettings settings

Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.

status

java.lang.String status

Current status of the stream processor.

Constraints:
Allowed Values: STOPPED, STARTING, RUNNING, FAILED, STOPPING, UPDATING

statusMessage

java.lang.String statusMessage

Detailed status message about the stream processor.

streamProcessorArn

java.lang.String streamProcessorArn

ARN of the stream processor.

Constraints:
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:streamprocessor\/.+$)

Class com.amazonaws.services.rekognition.model.DetectCustomLabelsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

image

Image image

Provides the input image either as bytes or an S3 object.

You pass image bytes to an Amazon Rekognition API operation by using the Bytes property. For example, you would use the Bytes property to pass an image loaded from a local file system. Image bytes passed by using the Bytes property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Amazon Rekognition API operations.

For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.

You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object property. Images stored in an S3 bucket do not need to be base64-encoded.

The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

maxResults

java.lang.Integer maxResults

Maximum number of results you want the service to return in the response. The service returns the specified number of highest confidence labels ranked from highest confidence to lowest.

Constraints:
Range: 0 -

minConfidence

java.lang.Float minConfidence

Specifies the minimum confidence level for the labels to return. DetectCustomLabels doesn't return any labels with a confidence value that's lower than this specified value. If you specify a value of 0, DetectCustomLabels returns all labels, regardless of the assumed threshold applied to each label. If you don't specify a value for MinConfidence, DetectCustomLabels returns labels based on the assumed threshold of each label.

Constraints:
Length: 0.0 - 100.0

projectVersionArn

java.lang.String projectVersionArn

The ARN of the model version that you want to use.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/version\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.DetectCustomLabelsResult extends java.lang.Object implements Serializable

Serialized Fields

customLabels

java.util.List<CustomLabel> customLabels

An array of custom labels detected in the input image.

Class com.amazonaws.services.rekognition.model.DetectFacesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

java.util.List<java.lang.String> attributes

An array of facial attributes you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide ["ALL"], all facial attributes are returned, but the operation takes longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

image

Image image

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Class com.amazonaws.services.rekognition.model.DetectFacesResult extends java.lang.Object implements Serializable

Serialized Fields

faceDetails

java.util.List<FaceDetail> faceDetails

Details of each face found in the image.

orientationCorrection

java.lang.String orientationCorrection

The value of OrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

Class com.amazonaws.services.rekognition.model.DetectionFilter extends java.lang.Object implements Serializable

Serialized Fields

minBoundingBoxHeight

java.lang.Float minBoundingBoxHeight

Sets the minimum height of the word bounding box. Words with bounding box heights lesser than this value will be excluded from the result. Value is relative to the video frame height.

Constraints:
Length: 0.0 - 1.0

minBoundingBoxWidth

java.lang.Float minBoundingBoxWidth

Sets the minimum width of the word bounding box. Words with bounding boxes widths lesser than this value will be excluded from the result. Value is relative to the video frame width.

Constraints:
Length: 0.0 - 1.0

minConfidence

java.lang.Float minConfidence

Sets the confidence of word detection. Words with detection confidence below this will be excluded from the result. Values should be between 0 and 100. The default MinConfidence is 80.

Constraints:
Length: 0.0 - 100.0

Class com.amazonaws.services.rekognition.model.DetectLabelsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

image

Image image

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an S3 Bucket do not need to be base64-encoded.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

maxLabels

java.lang.Integer maxLabels

Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.

Constraints:
Range: 0 -

minConfidence

java.lang.Float minConfidence

Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.

If MinConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent.

Constraints:
Length: 0.0 - 100.0

Class com.amazonaws.services.rekognition.model.DetectLabelsResult extends java.lang.Object implements Serializable

Serialized Fields

labelModelVersion

java.lang.String labelModelVersion

Version number of the label detection model that was used to detect labels.

labels

java.util.List<Label> labels

An array of labels for the real-world objects detected.

orientationCorrection

java.lang.String orientationCorrection

The value of OrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

Class com.amazonaws.services.rekognition.model.DetectModerationLabelsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

humanLoopConfig

HumanLoopConfig humanLoopConfig

Sets up the configuration for human evaluation, including the FlowDefinition the image will be sent to.

image

Image image

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

minConfidence

java.lang.Float minConfidence

Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value.

If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

Constraints:
Length: 0.0 - 100.0

Class com.amazonaws.services.rekognition.model.DetectModerationLabelsResult extends java.lang.Object implements Serializable

Serialized Fields

humanLoopActivationOutput

HumanLoopActivationOutput humanLoopActivationOutput

Shows the results of the human in the loop evaluation.

moderationLabels

java.util.List<ModerationLabel> moderationLabels

Array of detected Moderation labels and the time, in milliseconds from the start of the video, they were detected.

moderationModelVersion

java.lang.String moderationModelVersion

Version number of the moderation detection model that was used to detect unsafe content.

Class com.amazonaws.services.rekognition.model.DetectProtectiveEquipmentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

image

Image image

The image in which you want to detect PPE on detected persons. The image can be passed as image bytes or you can reference an image stored in an Amazon S3 bucket.

summarizationAttributes

ProtectiveEquipmentSummarizationAttributes summarizationAttributes

An array of PPE types that you want to summarize.

Class com.amazonaws.services.rekognition.model.DetectProtectiveEquipmentResult extends java.lang.Object implements Serializable

Serialized Fields

persons

java.util.List<ProtectiveEquipmentPerson> persons

An array of persons detected in the image (including persons not wearing PPE).

protectiveEquipmentModelVersion

java.lang.String protectiveEquipmentModelVersion

The version number of the PPE detection model used to detect PPE in the image.

summary

ProtectiveEquipmentSummary summary

Summary information for the types of PPE specified in the SummarizationAttributes input parameter.

Class com.amazonaws.services.rekognition.model.DetectTextFilters extends java.lang.Object implements Serializable

Serialized Fields

regionsOfInterest

java.util.List<RegionOfInterest> regionsOfInterest

A Filter focusing on a certain area of the image. Uses a BoundingBox object to set the region of the image.

wordFilter

DetectionFilter wordFilter

A set of parameters that allow you to filter out certain results from your returned results.

Class com.amazonaws.services.rekognition.model.DetectTextRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

DetectTextFilters filters

Optional parameters that let you set the criteria that the text must meet to be included in your response.

image

Image image

The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Class com.amazonaws.services.rekognition.model.DetectTextResult extends java.lang.Object implements Serializable

Serialized Fields

textDetections

java.util.List<TextDetection> textDetections

An array of text that was detected in the input image.

textModelVersion

java.lang.String textModelVersion

The model version used to detect text.

Class com.amazonaws.services.rekognition.model.DistributeDataset extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the dataset that you want to use.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/dataset\/(train|test)\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.DistributeDatasetEntriesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

datasets

java.util.List<DistributeDataset> datasets

The ARNS for the training dataset and test dataset that you want to use. The datasets must belong to the same project. The test dataset must be empty.

Class com.amazonaws.services.rekognition.model.DistributeDatasetEntriesResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.rekognition.model.Emotion extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

Level of confidence in the determination.

Constraints:
Length: 0.0 - 100.0

type

java.lang.String type

Type of emotion detected.

Constraints:
Allowed Values: HAPPY, SAD, ANGRY, CONFUSED, DISGUSTED, SURPRISED, CALM, UNKNOWN, FEAR

Class com.amazonaws.services.rekognition.model.EquipmentDetection extends java.lang.Object implements Serializable

Serialized Fields

boundingBox

BoundingBox boundingBox

A bounding box surrounding the item of detected PPE.

confidence

java.lang.Float confidence

The confidence that Amazon Rekognition has that the bounding box ( BoundingBox) contains an item of PPE.

Constraints:
Length: 0.0 - 100.0

coversBodyPart

CoversBodyPart coversBodyPart

Information about the body part covered by the detected PPE.

type

java.lang.String type

The type of detected PPE.

Constraints:
Allowed Values: FACE_COVER, HAND_COVER, HEAD_COVER

Class com.amazonaws.services.rekognition.model.EvaluationResult extends java.lang.Object implements Serializable

Serialized Fields

f1Score

java.lang.Float f1Score

The F1 score for the evaluation of all labels. The F1 score metric evaluates the overall precision and recall performance of the model as a single value. A higher value indicates better precision and recall performance. A lower score indicates that precision, recall, or both are performing poorly.

summary

Summary summary

The S3 bucket that contains the training summary.

Class com.amazonaws.services.rekognition.model.Eyeglasses extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

Level of confidence in the determination.

Constraints:
Length: 0.0 - 100.0

value

java.lang.Boolean value

Boolean value that indicates whether the face is wearing eye glasses or not.

Class com.amazonaws.services.rekognition.model.EyeOpen extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

Level of confidence in the determination.

Constraints:
Length: 0.0 - 100.0

value

java.lang.Boolean value

Boolean value that indicates whether the eyes on the face are open.

Class com.amazonaws.services.rekognition.model.Face extends java.lang.Object implements Serializable

Serialized Fields

boundingBox

BoundingBox boundingBox

Bounding box of the face.

confidence

java.lang.Float confidence

Confidence level that the bounding box contains a face (and not a different object such as a tree).

Constraints:
Length: 0.0 - 100.0

externalImageId

java.lang.String externalImageId

Identifier that you assign to all the faces in the input image.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-:]+

faceId

java.lang.String faceId

Unique identifier that Amazon Rekognition assigns to the face.

Constraints:
Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

imageId

java.lang.String imageId

Unique identifier that Amazon Rekognition assigns to the input image.

Constraints:
Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

indexFacesModelVersion

java.lang.String indexFacesModelVersion

The version of the face detect and storage model that was used when indexing the face vector.

Constraints:
Pattern: [0-9\.]+

Class com.amazonaws.services.rekognition.model.FaceDetail extends java.lang.Object implements Serializable

Serialized Fields

ageRange

AgeRange ageRange

The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.

beard

Beard beard

Indicates whether or not the face has a beard, and the confidence level in the determination.

boundingBox

BoundingBox boundingBox

Bounding box of the face. Default attribute.

confidence

java.lang.Float confidence

Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.

Constraints:
Length: 0.0 - 100.0

emotions

java.util.List<Emotion> emotions

The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.

eyeglasses

Eyeglasses eyeglasses

Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

eyesOpen

EyeOpen eyesOpen

Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

gender

Gender gender

The predicted gender of a detected face.

landmarks

java.util.List<Landmark> landmarks

Indicates the location of landmarks on the face. Default attribute.

mouthOpen

MouthOpen mouthOpen

Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

mustache

Mustache mustache

Indicates whether or not the face has a mustache, and the confidence level in the determination.

pose

Pose pose

Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.

quality

ImageQuality quality

Identifies image brightness and sharpness. Default attribute.

smile

Smile smile

Indicates whether or not the face is smiling, and the confidence level in the determination.

sunglasses

Sunglasses sunglasses

Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

Class com.amazonaws.services.rekognition.model.FaceDetection extends java.lang.Object implements Serializable

Serialized Fields

face

FaceDetail face

The face properties for the detected face.

timestamp

java.lang.Long timestamp

Time, in milliseconds from the start of the video, that the face was detected.

Class com.amazonaws.services.rekognition.model.FaceMatch extends java.lang.Object implements Serializable

Serialized Fields

face

Face face

Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned.

similarity

java.lang.Float similarity

Confidence in the match of this face with the input face.

Constraints:
Length: 0.0 - 100.0

Class com.amazonaws.services.rekognition.model.FaceRecord extends java.lang.Object implements Serializable

Serialized Fields

face

Face face

Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.

faceDetail

FaceDetail faceDetail

Structure containing attributes of the face that the algorithm detected.

Class com.amazonaws.services.rekognition.model.FaceSearchSettings extends java.lang.Object implements Serializable

Serialized Fields

collectionId

java.lang.String collectionId

The ID of a collection that contains faces that you want to search for.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

faceMatchThreshold

java.lang.Float faceMatchThreshold

Minimum face match confidence score that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted, and values lower than 80 are set to 80.

Constraints:
Length: 0.0 - 100.0

Class com.amazonaws.services.rekognition.model.Gender extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

Level of confidence in the prediction.

Constraints:
Length: 0.0 - 100.0

value

java.lang.String value

The predicted gender of the face.

Constraints:
Allowed Values: Male, Female

Class com.amazonaws.services.rekognition.model.Geometry extends java.lang.Object implements Serializable

Serialized Fields

boundingBox

BoundingBox boundingBox

An axis-aligned coarse representation of the detected item's location on the image.

polygon

java.util.List<Point> polygon

Within the bounding box, a fine-grained polygon around the detected item.

Class com.amazonaws.services.rekognition.model.GetCelebrityInfoRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

java.lang.String id

The ID for the celebrity. You get the celebrity ID from a call to the RecognizeCelebrities operation, which recognizes celebrities in an image.

Constraints:
Pattern: [0-9A-Za-z]*

Class com.amazonaws.services.rekognition.model.GetCelebrityInfoResult extends java.lang.Object implements Serializable

Serialized Fields

knownGender

KnownGender knownGender

Retrieves the known gender for the celebrity.

name

java.lang.String name

The name of the celebrity.

urls

java.util.List<java.lang.String> urls

An array of URLs pointing to additional celebrity information.

Class com.amazonaws.services.rekognition.model.GetCelebrityRecognitionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to StartCelebrityRecognition.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

maxResults

java.lang.Integer maxResults

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Constraints:
Range: 1 -

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of celebrities.

Constraints:
Length: - 255

sortBy

java.lang.String sortBy

Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity was recognized.

Constraints:
Allowed Values: ID, TIMESTAMP

Class com.amazonaws.services.rekognition.model.GetCelebrityRecognitionResult extends java.lang.Object implements Serializable

Serialized Fields

celebrities

java.util.List<CelebrityRecognition> celebrities

Array of celebrities recognized in the video.

jobStatus

java.lang.String jobStatus

The current status of the celebrity recognition job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

nextToken

java.lang.String nextToken

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of celebrities.

Constraints:
Length: - 255

statusMessage

java.lang.String statusMessage

If the job fails, StatusMessage provides a descriptive error message.

videoMetadata

VideoMetadata videoMetadata

Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

Class com.amazonaws.services.rekognition.model.GetContentModerationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier for the inappropriate, unwanted, or offensive content moderation job. Use JobId to identify the job in a subsequent call to GetContentModeration.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

maxResults

java.lang.Integer maxResults

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Constraints:
Range: 1 -

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of content moderation labels.

Constraints:
Length: - 255

sortBy

java.lang.String sortBy

Sort to use for elements in the ModerationLabelDetections array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

Constraints:
Allowed Values: NAME, TIMESTAMP

Class com.amazonaws.services.rekognition.model.GetContentModerationResult extends java.lang.Object implements Serializable

Serialized Fields

jobStatus

java.lang.String jobStatus

The current status of the content moderation analysis job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

moderationLabels

java.util.List<ContentModerationDetection> moderationLabels

The detected inappropriate, unwanted, or offensive content moderation labels and the time(s) they were detected.

moderationModelVersion

java.lang.String moderationModelVersion

Version number of the moderation detection model that was used to detect inappropriate, unwanted, or offensive content.

nextToken

java.lang.String nextToken

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of content moderation labels.

Constraints:
Length: - 255

statusMessage

java.lang.String statusMessage

If the job fails, StatusMessage provides a descriptive error message.

videoMetadata

VideoMetadata videoMetadata

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from GetContentModeration.

Class com.amazonaws.services.rekognition.model.GetFaceDetectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

Unique identifier for the face detection job. The JobId is returned from StartFaceDetection.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

maxResults

java.lang.Integer maxResults

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Constraints:
Range: 1 -

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there are more faces to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

Constraints:
Length: - 255

Class com.amazonaws.services.rekognition.model.GetFaceDetectionResult extends java.lang.Object implements Serializable

Serialized Fields

faces

java.util.List<FaceDetection> faces

An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.

jobStatus

java.lang.String jobStatus

The current status of the face detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

nextToken

java.lang.String nextToken

If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.

Constraints:
Length: - 255

statusMessage

java.lang.String statusMessage

If the job fails, StatusMessage provides a descriptive error message.

videoMetadata

VideoMetadata videoMetadata

Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

Class com.amazonaws.services.rekognition.model.GetFaceSearchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

maxResults

java.lang.Integer maxResults

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Constraints:
Range: 1 -

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

Constraints:
Length: - 255

sortBy

java.lang.String sortBy

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Constraints:
Allowed Values: INDEX, TIMESTAMP

Class com.amazonaws.services.rekognition.model.GetFaceSearchResult extends java.lang.Object implements Serializable

Serialized Fields

jobStatus

java.lang.String jobStatus

The current status of the face search job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

nextToken

java.lang.String nextToken

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.

Constraints:
Length: - 255

persons

java.util.List<PersonMatch> persons

An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person.

statusMessage

java.lang.String statusMessage

If the job fails, StatusMessage provides a descriptive error message.

videoMetadata

VideoMetadata videoMetadata

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

Class com.amazonaws.services.rekognition.model.GetLabelDetectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

maxResults

java.lang.Integer maxResults

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Constraints:
Range: 1 -

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of labels.

Constraints:
Length: - 255

sortBy

java.lang.String sortBy

Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

Constraints:
Allowed Values: NAME, TIMESTAMP

Class com.amazonaws.services.rekognition.model.GetLabelDetectionResult extends java.lang.Object implements Serializable

Serialized Fields

jobStatus

java.lang.String jobStatus

The current status of the label detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

labelModelVersion

java.lang.String labelModelVersion

Version number of the label detection model that was used to detect labels.

labels

java.util.List<LabelDetection> labels

An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.

nextToken

java.lang.String nextToken

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of labels.

Constraints:
Length: - 255

statusMessage

java.lang.String statusMessage

If the job fails, StatusMessage provides a descriptive error message.

videoMetadata

VideoMetadata videoMetadata

Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

Class com.amazonaws.services.rekognition.model.GetPersonTrackingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

maxResults

java.lang.Integer maxResults

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Constraints:
Range: 1 -

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of persons.

Constraints:
Length: - 255

sortBy

java.lang.String sortBy

Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP.

Constraints:
Allowed Values: INDEX, TIMESTAMP

Class com.amazonaws.services.rekognition.model.GetPersonTrackingResult extends java.lang.Object implements Serializable

Serialized Fields

jobStatus

java.lang.String jobStatus

The current status of the person tracking job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

nextToken

java.lang.String nextToken

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of persons.

Constraints:
Length: - 255

persons

java.util.List<PersonDetection> persons

An array of the persons detected in the video and the time(s) their path was tracked throughout the video. An array element will exist for each time a person's path is tracked.

statusMessage

java.lang.String statusMessage

If the job fails, StatusMessage provides a descriptive error message.

videoMetadata

VideoMetadata videoMetadata

Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

Class com.amazonaws.services.rekognition.model.GetSegmentDetectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

Job identifier for the text detection operation for which you want results returned. You get the job identifer from an initial call to StartSegmentDetection.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

maxResults

java.lang.Integer maxResults

Maximum number of results to return per paginated call. The largest value you can specify is 1000.

Constraints:
Range: 1 -

nextToken

java.lang.String nextToken

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.

Constraints:
Length: - 255

Class com.amazonaws.services.rekognition.model.GetSegmentDetectionResult extends java.lang.Object implements Serializable

Serialized Fields

audioMetadata

java.util.List<AudioMetadata> audioMetadata

An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.

jobStatus

java.lang.String jobStatus

Current status of the segment detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.

Constraints:
Length: - 255

segments

java.util.List<SegmentDetection> segments

An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.

selectedSegmentTypes

java.util.List<SegmentTypeInfo> selectedSegmentTypes

An array containing the segment types requested in the call to StartSegmentDetection.

statusMessage

java.lang.String statusMessage

If the job fails, StatusMessage provides a descriptive error message.

videoMetadata

java.util.List<VideoMetadata> videoMetadata

Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.

Class com.amazonaws.services.rekognition.model.GetTextDetectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

Job identifier for the text detection operation for which you want results returned. You get the job identifer from an initial call to StartTextDetection.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

maxResults

java.lang.Integer maxResults

Maximum number of results to return per paginated call. The largest value you can specify is 1000.

Constraints:
Range: 1 -

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.

Constraints:
Length: - 255

Class com.amazonaws.services.rekognition.model.GetTextDetectionResult extends java.lang.Object implements Serializable

Serialized Fields

jobStatus

java.lang.String jobStatus

Current status of the text detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

nextToken

java.lang.String nextToken

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.

Constraints:
Length: - 255

statusMessage

java.lang.String statusMessage

If the job fails, StatusMessage provides a descriptive error message.

textDetections

java.util.List<TextDetectionResult> textDetections

An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.

textModelVersion

java.lang.String textModelVersion

Version number of the text detection model that was used to detect text.

videoMetadata

VideoMetadata videoMetadata

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

Class com.amazonaws.services.rekognition.model.GroundTruthManifest extends java.lang.Object implements Serializable

Serialized Fields

s3Object

S3Object s3Object

Provides the S3 bucket name and object name.

The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

Class com.amazonaws.services.rekognition.model.HumanLoopActivationOutput extends java.lang.Object implements Serializable

Serialized Fields

humanLoopActivationConditionsEvaluationResults

java.lang.String humanLoopActivationConditionsEvaluationResults

Shows the result of condition evaluations, including those conditions which activated a human review.

Constraints:
Length: - 10240

humanLoopActivationReasons

java.util.List<java.lang.String> humanLoopActivationReasons

Shows if and why human review was needed.

humanLoopArn

java.lang.String humanLoopArn

The Amazon Resource Name (ARN) of the HumanLoop created.

Constraints:
Length: - 256

Class com.amazonaws.services.rekognition.model.HumanLoopConfig extends java.lang.Object implements Serializable

Serialized Fields

dataAttributes

HumanLoopDataAttributes dataAttributes

Sets attributes of the input data.

flowDefinitionArn

java.lang.String flowDefinitionArn

The Amazon Resource Name (ARN) of the flow definition. You can create a flow definition by using the Amazon Sagemaker CreateFlowDefinition Operation.

Constraints:
Length: - 256

humanLoopName

java.lang.String humanLoopName

The name of the human review used for this image. This should be kept unique within a region.

Constraints:
Length: 1 - 63
Pattern: ^[a-z0-9](-*[a-z0-9])*

Class com.amazonaws.services.rekognition.model.HumanLoopDataAttributes extends java.lang.Object implements Serializable

Serialized Fields

contentClassifiers

java.util.List<java.lang.String> contentClassifiers

Sets whether the input image is free of personally identifiable information.

Class com.amazonaws.services.rekognition.model.HumanLoopQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

quotaCode

java.lang.String quotaCode

The quota code.

resourceType

java.lang.String resourceType

The resource type.

serviceCode

java.lang.String serviceCode

The service code.

Class com.amazonaws.services.rekognition.model.IdempotentParameterMismatchException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.Image extends java.lang.Object implements Serializable

Serialized Fields

bytes

java.nio.ByteBuffer bytes

Blob of image bytes up to 5 MBs.

Constraints:
Length: 1 - 5242880

s3Object

S3Object s3Object

Identifies an S3 object as the image source.

Class com.amazonaws.services.rekognition.model.ImageQuality extends java.lang.Object implements Serializable

Serialized Fields

brightness

java.lang.Float brightness

Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

sharpness

java.lang.Float sharpness

Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

Class com.amazonaws.services.rekognition.model.ImageTooLargeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.IndexFacesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionId

java.lang.String collectionId

The ID of an existing collection to which you want to add the faces that are detected in the input images.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

detectionAttributes

java.util.List<java.lang.String> detectionAttributes

An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide ["ALL"], all facial attributes are returned, but the operation takes longer to complete.

If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

externalImageId

java.lang.String externalImageId

The ID you want to assign to all the faces detected in the image.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-:]+

image

Image image

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes isn't supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

maxFaces

java.lang.Integer maxFaces

The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1. IndexFaces returns no more than 100 detected faces in an image, even if you specify a larger value for MaxFaces.

If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number that's needed to satisfy the value of MaxFaces). Information about the unindexed faces is available in the UnindexedFaces array.

The faces that are returned by IndexFaces are sorted by the largest face bounding box size to the smallest size, in descending order.

MaxFaces can be used with a collection associated with any version of the face model.

Constraints:
Range: 1 -

qualityFilter

java.lang.String qualityFilter

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't indexed. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The default value is AUTO. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed.

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

Constraints:
Allowed Values: NONE, AUTO, LOW, MEDIUM, HIGH

Class com.amazonaws.services.rekognition.model.IndexFacesResult extends java.lang.Object implements Serializable

Serialized Fields

faceModelVersion

java.lang.String faceModelVersion

The version number of the face detection model that's associated with the input collection (CollectionId).

faceRecords

java.util.List<FaceRecord> faceRecords

An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

orientationCorrection

java.lang.String orientationCorrection

If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.

If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:

• If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction - the bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. The value of OrientationCorrection is null.

• If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

Bounding box information is returned in the FaceRecords array. You can get the version of the face detection model by calling DescribeCollection.

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

unindexedFaces

java.util.List<UnindexedFace> unindexedFaces

An array of faces that were detected in the image but weren't indexed. They weren't indexed because the quality filter identified them as low quality, or the MaxFaces request parameter filtered them out. To use the quality filter, you specify the QualityFilter request parameter.

Class com.amazonaws.services.rekognition.model.Instance extends java.lang.Object implements Serializable

Serialized Fields

boundingBox

BoundingBox boundingBox

The position of the label instance on the image.

confidence

java.lang.Float confidence

The confidence that Amazon Rekognition has in the accuracy of the bounding box.

Constraints:
Length: 0.0 - 100.0

Class com.amazonaws.services.rekognition.model.InternalServerErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.InvalidImageFormatException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.InvalidPaginationTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.InvalidPolicyRevisionIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.InvalidS3ObjectException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.KinesisDataStream extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

ARN of the output Amazon Kinesis Data Streams stream.

Constraints:
Pattern: (^arn:([a-z\d-]+):kinesis:([a-z\d-]+):\d{12}:.+$)

Class com.amazonaws.services.rekognition.model.KinesisVideoStream extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

ARN of the Kinesis video stream stream that streams the source video.

Constraints:
Pattern: (^arn:([a-z\d-]+):kinesisvideo:([a-z\d-]+):\d{12}:.+$)

Class com.amazonaws.services.rekognition.model.KinesisVideoStreamStartSelector extends java.lang.Object implements Serializable

Serialized Fields

fragmentNumber

java.lang.String fragmentNumber

The unique identifier of the fragment. This value monotonically increases based on the ingestion order.

Constraints:
Length: 1 - 128
Pattern: ^[0-9]+$

producerTimestamp

java.lang.Long producerTimestamp

The timestamp from the producer corresponding to the fragment.

Constraints:
Range: 0 -

Class com.amazonaws.services.rekognition.model.KnownGender extends java.lang.Object implements Serializable

Serialized Fields

type

java.lang.String type

A string value of the KnownGender info about the Celebrity.

Constraints:
Allowed Values: Male, Female, Nonbinary, Unlisted

Class com.amazonaws.services.rekognition.model.Label extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

Level of confidence.

Constraints:
Length: 0.0 - 100.0

instances

java.util.List<Instance> instances

If Label represents an object, Instances contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.

name

java.lang.String name

The name (label) of the object or scene.

parents

java.util.List<Parent> parents

The parent labels for a label. The response includes all ancestor labels.

Class com.amazonaws.services.rekognition.model.LabelDetection extends java.lang.Object implements Serializable

Serialized Fields

label

Label label

Details about the detected label.

timestamp

java.lang.Long timestamp

Time, in milliseconds from the start of the video, that the label was detected.

Class com.amazonaws.services.rekognition.model.Landmark extends java.lang.Object implements Serializable

Serialized Fields

type

java.lang.String type

Type of landmark.

Constraints:
Allowed Values: eyeLeft, eyeRight, nose, mouthLeft, mouthRight, leftEyeBrowLeft, leftEyeBrowRight, leftEyeBrowUp, rightEyeBrowLeft, rightEyeBrowRight, rightEyeBrowUp, leftEyeLeft, leftEyeRight, leftEyeUp, leftEyeDown, rightEyeLeft, rightEyeRight, rightEyeUp, rightEyeDown, noseLeft, noseRight, mouthUp, mouthDown, leftPupil, rightPupil, upperJawlineLeft, midJawlineLeft, chinBottom, midJawlineRight, upperJawlineRight

x

java.lang.Float x

The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

y

java.lang.Float y

The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.

Class com.amazonaws.services.rekognition.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.ListCollectionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

Maximum number of collection IDs to return.

Constraints:
Range: 0 - 4096

nextToken

java.lang.String nextToken

Pagination token from the previous response.

Constraints:
Length: - 255

Class com.amazonaws.services.rekognition.model.ListCollectionsResult extends java.lang.Object implements Serializable

Serialized Fields

collectionIds

java.util.List<java.lang.String> collectionIds

An array of collection IDs.

faceModelVersions

java.util.List<java.lang.String> faceModelVersions

Version numbers of the face detection models associated with the collections in the array CollectionIds. For example, the value of FaceModelVersions[2] is the version number for the face detection model used by the collection in CollectionId[2].

nextToken

java.lang.String nextToken

If the result is truncated, the response provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

Constraints:
Length: - 255

Class com.amazonaws.services.rekognition.model.ListDatasetEntriesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

containsLabels

java.util.List<java.lang.String> containsLabels

Specifies a label filter for the response. The response includes an entry only if one or more of the labels in ContainsLabels exist in the entry.

datasetArn

java.lang.String datasetArn

The Amazon Resource Name (ARN) for the dataset that you want to use.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/dataset\/(train|test)\/[0-9]+$)

hasErrors

java.lang.Boolean hasErrors

Specifies an error filter for the response. Specify True to only include entries that have errors.

labeled

java.lang.Boolean labeled

Specify true to get only the JSON Lines where the image is labeled. Specify false to get only the JSON Lines where the image isn't labeled. If you don't specify Labeled, ListDatasetEntries returns JSON Lines for labeled and unlabeled images.

maxResults

java.lang.Integer maxResults

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Constraints:
Length: - 1024

sourceRefContains

java.lang.String sourceRefContains

If specified, ListDatasetEntries only returns JSON Lines where the value of SourceRefContains is part of the source-ref field. The source-ref field contains the Amazon S3 location of the image. You can use SouceRefContains for tasks such as getting the JSON Line for a single image, or gettting JSON Lines for all images within a specific folder.

Constraints:
Length: 1 - 2048
Pattern: .*\S.*

Class com.amazonaws.services.rekognition.model.ListDatasetEntriesResult extends java.lang.Object implements Serializable

Serialized Fields

datasetEntries

java.util.List<java.lang.String> datasetEntries

A list of entries (images) in the dataset.

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Constraints:
Length: - 1024

Class com.amazonaws.services.rekognition.model.ListDatasetLabelsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

datasetArn

java.lang.String datasetArn

The Amazon Resource Name (ARN) of the dataset that you want to use.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/dataset\/(train|test)\/[0-9]+$)

maxResults

java.lang.Integer maxResults

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Constraints:
Length: - 1024

Class com.amazonaws.services.rekognition.model.ListDatasetLabelsResult extends java.lang.Object implements Serializable

Serialized Fields

datasetLabelDescriptions

java.util.List<DatasetLabelDescription> datasetLabelDescriptions

A list of the labels in the dataset.

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Constraints:
Length: - 1024

Class com.amazonaws.services.rekognition.model.ListFacesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionId

java.lang.String collectionId

ID of the collection from which to list the faces.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

maxResults

java.lang.Integer maxResults

Maximum number of faces to return.

Constraints:
Range: 0 - 4096

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

Constraints:
Length: - 255

Class com.amazonaws.services.rekognition.model.ListFacesResult extends java.lang.Object implements Serializable

Serialized Fields

faceModelVersion

java.lang.String faceModelVersion

Version number of the face detection model associated with the input collection (CollectionId).

faces

java.util.List<Face> faces

An array of Face objects.

nextToken

java.lang.String nextToken

If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.

Class com.amazonaws.services.rekognition.model.ListProjectPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of results to return per paginated call. The largest value you can specify is 5. If you specify a value greater than 5, a ValidationException error occurs. The default value is 5.

Constraints:
Range: 1 - 5

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Constraints:
Length: - 1024

projectArn

java.lang.String projectArn

The ARN of the project for which you want to list the project policies.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.ListProjectPoliciesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of project policies.

Constraints:
Length: - 1024

projectPolicies

java.util.List<ProjectPolicy> projectPolicies

A list of project policies attached to the project.

Class com.amazonaws.services.rekognition.model.ListStreamProcessorsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000.

Constraints:
Range: 1 -

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there are more stream processors to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of stream processors.

Constraints:
Length: - 255

Class com.amazonaws.services.rekognition.model.ListStreamProcessorsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of stream processors.

Constraints:
Length: - 255

streamProcessors

java.util.List<StreamProcessor> streamProcessors

List of stream processors that you have created.

Class com.amazonaws.services.rekognition.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

Amazon Resource Name (ARN) of the model, collection, or stream processor that contains the tags that you want a list of.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.rekognition.model.ListTagsForResourceResult extends java.lang.Object implements Serializable

Serialized Fields

tags

java.util.Map<java.lang.String,java.lang.String> tags

A list of key-value tags assigned to the resource.

Class com.amazonaws.services.rekognition.model.MalformedPolicyDocumentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.ModerationLabel extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

Specifies the confidence that Amazon Rekognition has that the label has been correctly identified.

If you don't specify the MinConfidence parameter in the call to DetectModerationLabels, the operation returns labels with a confidence value greater than or equal to 50 percent.

Constraints:
Length: 0.0 - 100.0

name

java.lang.String name

The label name for the type of unsafe content detected in the image.

parentName

java.lang.String parentName

The name for the parent label. Labels at the top level of the hierarchy have the parent label "".

Class com.amazonaws.services.rekognition.model.MouthOpen extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

Level of confidence in the determination.

Constraints:
Length: 0.0 - 100.0

value

java.lang.Boolean value

Boolean value that indicates whether the mouth on the face is open or not.

Class com.amazonaws.services.rekognition.model.Mustache extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

Level of confidence in the determination.

Constraints:
Length: 0.0 - 100.0

value

java.lang.Boolean value

Boolean value that indicates whether the face has mustache or not.

Class com.amazonaws.services.rekognition.model.NotificationChannel extends java.lang.Object implements Serializable

Serialized Fields

roleArn

java.lang.String roleArn

The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.

Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

sNSTopicArn

java.lang.String sNSTopicArn

The Amazon SNS topic to which Amazon Rekognition posts the completion status.

Constraints:
Pattern: (^arn:aws:sns:.*:\w{12}:.+$)

Class com.amazonaws.services.rekognition.model.OutputConfig extends java.lang.Object implements Serializable

Serialized Fields

s3Bucket

java.lang.String s3Bucket

The S3 bucket where training output is placed.

Constraints:
Length: 3 - 255
Pattern: [0-9A-Za-z\.\-_]*

s3KeyPrefix

java.lang.String s3KeyPrefix

The prefix applied to the training output files.

Constraints:
Length: - 1024

Class com.amazonaws.services.rekognition.model.Parent extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the parent label.

Class com.amazonaws.services.rekognition.model.PersonDetail extends java.lang.Object implements Serializable

Serialized Fields

boundingBox

BoundingBox boundingBox

Bounding box around the detected person.

face

FaceDetail face

Face details for the detected person.

index

java.lang.Long index

Identifier for the person detected person within a video. Use to keep track of the person throughout the video. The identifier is not stored by Amazon Rekognition.

Class com.amazonaws.services.rekognition.model.PersonDetection extends java.lang.Object implements Serializable

Serialized Fields

person

PersonDetail person

Details about a person whose path was tracked in a video.

timestamp

java.lang.Long timestamp

The time, in milliseconds from the start of the video, that the person's path was tracked.

Class com.amazonaws.services.rekognition.model.PersonMatch extends java.lang.Object implements Serializable

Serialized Fields

faceMatches

java.util.List<FaceMatch> faceMatches

Information about the faces in the input collection that match the face of a person in the video.

person

PersonDetail person

Information about the matched person.

timestamp

java.lang.Long timestamp

The time, in milliseconds from the beginning of the video, that the person was matched in the video.

Class com.amazonaws.services.rekognition.model.Point extends java.lang.Object implements Serializable

Serialized Fields

x

java.lang.Float x

The value of the X coordinate for a point on a Polygon.

y

java.lang.Float y

The value of the Y coordinate for a point on a Polygon.

Class com.amazonaws.services.rekognition.model.Pose extends java.lang.Object implements Serializable

Serialized Fields

pitch

java.lang.Float pitch

Value representing the face rotation on the pitch axis.

Constraints:
Length: -180.0 - 180.0

roll

java.lang.Float roll

Value representing the face rotation on the roll axis.

Constraints:
Length: -180.0 - 180.0

yaw

java.lang.Float yaw

Value representing the face rotation on the yaw axis.

Constraints:
Length: -180.0 - 180.0

Class com.amazonaws.services.rekognition.model.ProjectDescription extends java.lang.Object implements Serializable

Serialized Fields

creationTimestamp

java.util.Date creationTimestamp

The Unix timestamp for the date and time that the project was created.

datasets

java.util.List<DatasetMetadata> datasets

Information about the training and test datasets in the project.

projectArn

java.lang.String projectArn

The Amazon Resource Name (ARN) of the project.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/[0-9]+$)

status

java.lang.String status

The current status of the project.

Constraints:
Allowed Values: CREATING, CREATED, DELETING

Class com.amazonaws.services.rekognition.model.ProjectPolicy extends java.lang.Object implements Serializable

Serialized Fields

creationTimestamp

java.util.Date creationTimestamp

The Unix datetime for the creation of the project policy.

lastUpdatedTimestamp

java.util.Date lastUpdatedTimestamp

The Unix datetime for when the project policy was last updated.

policyDocument

java.lang.String policyDocument

The JSON document for the project policy.

Constraints:
Length: 1 - 2000
Pattern: [ -ÿ]+

policyName

java.lang.String policyName

The name of the project policy.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.\-]+

policyRevisionId

java.lang.String policyRevisionId

The revision ID of the project policy.

Constraints:
Length: - 64
Pattern: [0-9A-Fa-f]+

projectArn

java.lang.String projectArn

The Amazon Resource Name (ARN) of the project to which the project policy is attached.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.ProjectVersionDescription extends java.lang.Object implements Serializable

Serialized Fields

billableTrainingTimeInSeconds

java.lang.Long billableTrainingTimeInSeconds

The duration, in seconds, that you were billed for a successful training of the model version. This value is only returned if the model version has been successfully trained.

Constraints:
Range: 0 -

creationTimestamp

java.util.Date creationTimestamp

The Unix datetime for the date and time that training started.

evaluationResult

EvaluationResult evaluationResult

The training results. EvaluationResult is only returned if training is successful.

kmsKeyId

java.lang.String kmsKeyId

The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.

Constraints:
Length: 1 - 2048
Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

manifestSummary

GroundTruthManifest manifestSummary

The location of the summary manifest. The summary manifest provides aggregate data validation results for the training and test datasets.

maxInferenceUnits

java.lang.Integer maxInferenceUnits

The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model. For more information, see StartProjectVersion.

Constraints:
Range: 1 -

minInferenceUnits

java.lang.Integer minInferenceUnits

The minimum number of inference units used by the model. For more information, see StartProjectVersion.

Constraints:
Range: 1 -

outputConfig

OutputConfig outputConfig

The location where training results are saved.

projectVersionArn

java.lang.String projectVersionArn

The Amazon Resource Name (ARN) of the model version.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/version\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)

sourceProjectVersionArn

java.lang.String sourceProjectVersionArn

If the model version was copied from a different project, SourceProjectVersionArn contains the ARN of the source model version.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/version\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)

status

java.lang.String status

The current status of the model version.

Constraints:
Allowed Values: TRAINING_IN_PROGRESS, TRAINING_COMPLETED, TRAINING_FAILED, STARTING, RUNNING, FAILED, STOPPING, STOPPED, DELETING, COPYING_IN_PROGRESS, COPYING_COMPLETED, COPYING_FAILED

statusMessage

java.lang.String statusMessage

A descriptive message for an error or warning that occurred.

testingDataResult

TestingDataResult testingDataResult

Contains information about the testing results.

trainingDataResult

TrainingDataResult trainingDataResult

Contains information about the training results.

trainingEndTimestamp

java.util.Date trainingEndTimestamp

The Unix date and time that training of the model ended.

Class com.amazonaws.services.rekognition.model.ProtectiveEquipmentBodyPart extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

The confidence that Amazon Rekognition has in the detection accuracy of the detected body part.

Constraints:
Length: 0.0 - 100.0

equipmentDetections

java.util.List<EquipmentDetection> equipmentDetections

An array of Personal Protective Equipment items detected around a body part.

name

java.lang.String name

The detected body part.

Constraints:
Allowed Values: FACE, HEAD, LEFT_HAND, RIGHT_HAND

Class com.amazonaws.services.rekognition.model.ProtectiveEquipmentPerson extends java.lang.Object implements Serializable

Serialized Fields

bodyParts

java.util.List<ProtectiveEquipmentBodyPart> bodyParts

An array of body parts detected on a person's body (including body parts without PPE).

boundingBox

BoundingBox boundingBox

A bounding box around the detected person.

confidence

java.lang.Float confidence

The confidence that Amazon Rekognition has that the bounding box contains a person.

Constraints:
Length: 0.0 - 100.0

id

java.lang.Integer id

The identifier for the detected person. The identifier is only unique for a single call to DetectProtectiveEquipment.

Constraints:
Range: 0 -

Class com.amazonaws.services.rekognition.model.ProtectiveEquipmentSummarizationAttributes extends java.lang.Object implements Serializable

Serialized Fields

minConfidence

java.lang.Float minConfidence

The minimum confidence level for which you want summary information. The confidence level applies to person detection, body part detection, equipment detection, and body part coverage. Amazon Rekognition doesn't return summary information with a confidence than this specified value. There isn't a default value.

Specify a MinConfidence value that is between 50-100% as DetectProtectiveEquipment returns predictions only where the detection confidence is between 50% - 100%. If you specify a value that is less than 50%, the results are the same specifying a value of 50%.

Constraints:
Length: 0.0 - 100.0

requiredEquipmentTypes

java.util.List<java.lang.String> requiredEquipmentTypes

An array of personal protective equipment types for which you want summary information. If a person is detected wearing a required requipment type, the person's ID is added to the PersonsWithRequiredEquipment array field returned in ProtectiveEquipmentSummary by DetectProtectiveEquipment.

Class com.amazonaws.services.rekognition.model.ProtectiveEquipmentSummary extends java.lang.Object implements Serializable

Serialized Fields

personsIndeterminate

java.util.List<java.lang.Integer> personsIndeterminate

An array of IDs for persons where it was not possible to determine if they are wearing personal protective equipment.

personsWithoutRequiredEquipment

java.util.List<java.lang.Integer> personsWithoutRequiredEquipment

An array of IDs for persons who are not wearing all of the types of PPE specified in the RequiredEquipmentTypes field of the detected personal protective equipment.

personsWithRequiredEquipment

java.util.List<java.lang.Integer> personsWithRequiredEquipment

An array of IDs for persons who are wearing detected personal protective equipment.

Class com.amazonaws.services.rekognition.model.ProvisionedThroughputExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.PutProjectPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyDocument

java.lang.String policyDocument

A resource policy to add to the model. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see IAM JSON policy reference.

Constraints:
Length: 1 - 2000
Pattern: [ -ÿ]+

policyName

java.lang.String policyName

A name for the policy.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.\-]+

policyRevisionId

java.lang.String policyRevisionId

The revision ID for the Project Policy. Each time you modify a policy, Amazon Rekognition Custom Labels generates and assigns a new PolicyRevisionId and then deletes the previous version of the policy.

Constraints:
Length: - 64
Pattern: [0-9A-Fa-f]+

projectArn

java.lang.String projectArn

The Amazon Resource Name (ARN) of the project that the project policy is attached to.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.PutProjectPolicyResult extends java.lang.Object implements Serializable

Serialized Fields

policyRevisionId

java.lang.String policyRevisionId

The ID of the project policy.

Constraints:
Length: - 64
Pattern: [0-9A-Fa-f]+

Class com.amazonaws.services.rekognition.model.RecognizeCelebritiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

image

Image image

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Class com.amazonaws.services.rekognition.model.RecognizeCelebritiesResult extends java.lang.Object implements Serializable

Serialized Fields

celebrityFaces

java.util.List<Celebrity> celebrityFaces

Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64 celebrities in an image. Each celebrity object includes the following attributes: Face, Confidence, Emotions, Landmarks, Pose, Quality, Smile, Id, KnownGender, MatchConfidence, Name, Urls.

orientationCorrection

java.lang.String orientationCorrection

Support for estimating image orientation using the the OrientationCorrection field has ceased as of August 2021. Any returned values for this field included in an API response will always be NULL.

The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in CelebrityFaces and UnrecognizedFaces represent face locations before the image orientation is corrected.

If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of OrientationCorrection is null. The CelebrityFaces and UnrecognizedFaces bounding box coordinates represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Constraints:
Allowed Values: ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270

unrecognizedFaces

java.util.List<ComparedFace> unrecognizedFaces

Details about each unrecognized face in the image.

Class com.amazonaws.services.rekognition.model.RegionOfInterest extends java.lang.Object implements Serializable

Serialized Fields

boundingBox

BoundingBox boundingBox

The box representing a region of interest on screen.

polygon

java.util.List<Point> polygon

Specifies a shape made up of up to 10 Point objects to define a region of interest.

Class com.amazonaws.services.rekognition.model.ResourceAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.ResourceNotReadyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.S3Destination extends java.lang.Object implements Serializable

Serialized Fields

bucket

java.lang.String bucket

The name of the Amazon S3 bucket you want to associate with the streaming video project. You must be the owner of the Amazon S3 bucket.

Constraints:
Length: 3 - 255
Pattern: [0-9A-Za-z\.\-_]*

keyPrefix

java.lang.String keyPrefix

The prefix value of the location within the bucket that you want the information to be published to. For more information, see Using prefixes.

Constraints:
Length: - 1024

Class com.amazonaws.services.rekognition.model.S3Object extends java.lang.Object implements Serializable

Serialized Fields

bucket

java.lang.String bucket

Name of the S3 bucket.

Constraints:
Length: 3 - 255
Pattern: [0-9A-Za-z\.\-_]*

name

java.lang.String name

S3 object key name.

Constraints:
Length: 1 - 1024

version

java.lang.String version

If the bucket is versioning enabled, you can specify the object version.

Constraints:
Length: 1 - 1024

Class com.amazonaws.services.rekognition.model.SearchFacesByImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionId

java.lang.String collectionId

ID of the collection to search.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

faceMatchThreshold

java.lang.Float faceMatchThreshold

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

Constraints:
Length: 0.0 - 100.0

image

Image image

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

maxFaces

java.lang.Integer maxFaces

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Constraints:
Range: 1 - 4096

qualityFilter

java.lang.String qualityFilter

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

Constraints:
Allowed Values: NONE, AUTO, LOW, MEDIUM, HIGH

Class com.amazonaws.services.rekognition.model.SearchFacesByImageResult extends java.lang.Object implements Serializable

Serialized Fields

faceMatches

java.util.List<FaceMatch> faceMatches

An array of faces that match the input face, along with the confidence in the match.

faceModelVersion

java.lang.String faceModelVersion

Version number of the face detection model associated with the input collection (CollectionId).

searchedFaceBoundingBox

BoundingBox searchedFaceBoundingBox

The bounding box around the face in the input image that Amazon Rekognition used for the search.

searchedFaceConfidence

java.lang.Float searchedFaceConfidence

The level of confidence that the searchedFaceBoundingBox, contains a face.

Constraints:
Length: 0.0 - 100.0

Class com.amazonaws.services.rekognition.model.SearchFacesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

collectionId

java.lang.String collectionId

ID of the collection the face belongs to.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

faceId

java.lang.String faceId

ID of a face to find matches for in the collection.

Constraints:
Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

faceMatchThreshold

java.lang.Float faceMatchThreshold

Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

Constraints:
Length: 0.0 - 100.0

maxFaces

java.lang.Integer maxFaces

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Constraints:
Range: 1 - 4096

Class com.amazonaws.services.rekognition.model.SearchFacesResult extends java.lang.Object implements Serializable

Serialized Fields

faceMatches

java.util.List<FaceMatch> faceMatches

An array of faces that matched the input face, along with the confidence in the match.

faceModelVersion

java.lang.String faceModelVersion

Version number of the face detection model associated with the input collection (CollectionId).

searchedFaceId

java.lang.String searchedFaceId

ID of the face that was searched for matches in a collection.

Constraints:
Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Class com.amazonaws.services.rekognition.model.Section extends java.lang.Object implements Serializable

Serialized Fields

endTimestamp

java.lang.Long endTimestamp

The new value for the endTimestamp property for this object.

startTimestamp

java.lang.Long startTimestamp

The new value for the startTimestamp property for this object.

Class com.amazonaws.services.rekognition.model.SegmentDetection extends java.lang.Object implements Serializable

Serialized Fields

durationFrames

java.lang.Long durationFrames

The duration of a video segment, expressed in frames.

Constraints:
Range: 0 -

durationMillis

java.lang.Long durationMillis

The duration of the detected segment in milliseconds.

Constraints:
Range: 0 -

durationSMPTE

java.lang.String durationSMPTE

The duration of the timecode for the detected segment in SMPTE format.

endFrameNumber

java.lang.Long endFrameNumber

The frame number at the end of a video segment, using a frame index that starts with 0.

Constraints:
Range: 0 -

endTimecodeSMPTE

java.lang.String endTimecodeSMPTE

The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment. EndTimecode is in HH:MM:SS:fr format (and ;fr for drop frame-rates).

endTimestampMillis

java.lang.Long endTimestampMillis

The end time of the detected segment, in milliseconds, from the start of the video. This value is rounded down.

shotSegment

ShotSegment shotSegment

If the segment is a shot detection, contains information about the shot detection.

startFrameNumber

java.lang.Long startFrameNumber

The frame number of the start of a video segment, using a frame index that starts with 0.

Constraints:
Range: 0 -

startTimecodeSMPTE

java.lang.String startTimecodeSMPTE

The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment. StartTimecode is in HH:MM:SS:fr format (and ;fr for drop frame-rates).

startTimestampMillis

java.lang.Long startTimestampMillis

The start time of the detected segment in milliseconds from the start of the video. This value is rounded down. For example, if the actual timestamp is 100.6667 milliseconds, Amazon Rekognition Video returns a value of 100 millis.

technicalCueSegment

TechnicalCueSegment technicalCueSegment

If the segment is a technical cue, contains information about the technical cue.

type

java.lang.String type

The type of the segment. Valid values are TECHNICAL_CUE and SHOT.

Constraints:
Allowed Values: TECHNICAL_CUE, SHOT

Class com.amazonaws.services.rekognition.model.SegmentTypeInfo extends java.lang.Object implements Serializable

Serialized Fields

modelVersion

java.lang.String modelVersion

The version of the model used to detect segments.

type

java.lang.String type

The type of a segment (technical cue or shot detection).

Constraints:
Allowed Values: TECHNICAL_CUE, SHOT

Class com.amazonaws.services.rekognition.model.ServiceQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.ShotSegment extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.

Constraints:
Length: 50.0 - 100.0

index

java.lang.Long index

An Identifier for a shot detection segment detected in a video.

Constraints:
Range: 0 -

Class com.amazonaws.services.rekognition.model.Smile extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

Level of confidence in the determination.

Constraints:
Length: 0.0 - 100.0

value

java.lang.Boolean value

Boolean value that indicates whether the face is smiling or not.

Class com.amazonaws.services.rekognition.model.StartCelebrityRecognitionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

Idempotent token used to identify the start request. If you use the same token with multiple StartCelebrityRecognition requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

jobTag

java.lang.String jobTag

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.\-:]+

notificationChannel

NotificationChannel notificationChannel

The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

video

Video video

The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.

Class com.amazonaws.services.rekognition.model.StartCelebrityRecognitionResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier for the celebrity recognition analysis job. Use JobId to identify the job in a subsequent call to GetCelebrityRecognition.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Class com.amazonaws.services.rekognition.model.StartContentModerationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

Idempotent token used to identify the start request. If you use the same token with multiple StartContentModeration requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

jobTag

java.lang.String jobTag

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.\-:]+

minConfidence

java.lang.Float minConfidence

Specifies the minimum confidence that Amazon Rekognition must have in order to return a moderated content label. Confidence represents how certain Amazon Rekognition is that the moderated content is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition doesn't return any moderated content labels with a confidence level lower than this specified value. If you don't specify MinConfidence, GetContentModeration returns labels with confidence values greater than or equal to 50 percent.

Constraints:
Length: 0.0 - 100.0

notificationChannel

NotificationChannel notificationChannel

The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the content analysis to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

video

Video video

The video in which you want to detect inappropriate, unwanted, or offensive content. The video must be stored in an Amazon S3 bucket.

Class com.amazonaws.services.rekognition.model.StartContentModerationResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier for the content analysis job. Use JobId to identify the job in a subsequent call to GetContentModeration.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Class com.amazonaws.services.rekognition.model.StartFaceDetectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

Idempotent token used to identify the start request. If you use the same token with multiple StartFaceDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

faceAttributes

java.lang.String faceAttributes

The face attributes you want returned.

DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

ALL - All facial attributes are returned.

Constraints:
Allowed Values: DEFAULT, ALL

jobTag

java.lang.String jobTag

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.\-:]+

notificationChannel

NotificationChannel notificationChannel

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

video

Video video

The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.

Class com.amazonaws.services.rekognition.model.StartFaceDetectionResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier for the face detection job. Use JobId to identify the job in a subsequent call to GetFaceDetection.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Class com.amazonaws.services.rekognition.model.StartFaceSearchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

Idempotent token used to identify the start request. If you use the same token with multiple StartFaceSearch requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

collectionId

java.lang.String collectionId

ID of the collection that contains the faces you want to search for.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

faceMatchThreshold

java.lang.Float faceMatchThreshold

The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

Constraints:
Length: 0.0 - 100.0

jobTag

java.lang.String jobTag

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.\-:]+

notificationChannel

NotificationChannel notificationChannel

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

video

Video video

The video you want to search. The video must be stored in an Amazon S3 bucket.

Class com.amazonaws.services.rekognition.model.StartFaceSearchResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier for the search job. Use JobId to identify the job in a subsequent call to GetFaceSearch.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Class com.amazonaws.services.rekognition.model.StartLabelDetectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

Idempotent token used to identify the start request. If you use the same token with multiple StartLabelDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

jobTag

java.lang.String jobTag

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.\-:]+

minConfidence

java.lang.Float minConfidence

Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level lower than this specified value.

If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

Constraints:
Length: 0.0 - 100.0

notificationChannel

NotificationChannel notificationChannel

The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

video

Video video

The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.

Class com.amazonaws.services.rekognition.model.StartLabelDetectionResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier for the label detection job. Use JobId to identify the job in a subsequent call to GetLabelDetection.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Class com.amazonaws.services.rekognition.model.StartPersonTrackingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

Idempotent token used to identify the start request. If you use the same token with multiple StartPersonTracking requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

jobTag

java.lang.String jobTag

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.\-:]+

notificationChannel

NotificationChannel notificationChannel

The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

video

Video video

The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.

Class com.amazonaws.services.rekognition.model.StartPersonTrackingResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier for the person detection job. Use JobId to identify the job in a subsequent call to GetPersonTracking.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Class com.amazonaws.services.rekognition.model.StartProjectVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxInferenceUnits

java.lang.Integer maxInferenceUnits

The maximum number of inference units to use for auto-scaling the model. If you don't specify a value, Amazon Rekognition Custom Labels doesn't auto-scale the model.

Constraints:
Range: 1 -

minInferenceUnits

java.lang.Integer minInferenceUnits

The minimum number of inference units to use. A single inference unit represents 1 hour of processing.

For information about the number of transactions per second (TPS) that an inference unit can support, see Running a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels Guide.

Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.

Constraints:
Range: 1 -

projectVersionArn

java.lang.String projectVersionArn

The Amazon Resource Name(ARN) of the model version that you want to start.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/version\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.StartProjectVersionResult extends java.lang.Object implements Serializable

Serialized Fields

status

java.lang.String status

The current running status of the model.

Constraints:
Allowed Values: TRAINING_IN_PROGRESS, TRAINING_COMPLETED, TRAINING_FAILED, STARTING, RUNNING, FAILED, STOPPING, STOPPED, DELETING, COPYING_IN_PROGRESS, COPYING_COMPLETED, COPYING_FAILED

Class com.amazonaws.services.rekognition.model.StartSegmentDetectionFilters extends java.lang.Object implements Serializable

Serialized Fields

shotFilter

StartShotDetectionFilter shotFilter

Filters that are specific to shot detections.

technicalCueFilter

StartTechnicalCueDetectionFilter technicalCueFilter

Filters that are specific to technical cues.

Class com.amazonaws.services.rekognition.model.StartSegmentDetectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

Idempotent token used to identify the start request. If you use the same token with multiple StartSegmentDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

filters

StartSegmentDetectionFilters filters

Filters for technical cue or shot detection.

jobTag

java.lang.String jobTag

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.\-:]+

notificationChannel

NotificationChannel notificationChannel

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

segmentTypes

java.util.List<java.lang.String> segmentTypes

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

video

Video video

Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.

Class com.amazonaws.services.rekognition.model.StartSegmentDetectionResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

Unique identifier for the segment detection job. The JobId is returned from StartSegmentDetection.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Class com.amazonaws.services.rekognition.model.StartShotDetectionFilter extends java.lang.Object implements Serializable

Serialized Fields

minSegmentConfidence

java.lang.Float minSegmentConfidence

Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected segment. Confidence represents how certain Amazon Rekognition is that a segment is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any segments with a confidence level lower than this specified value.

If you don't specify MinSegmentConfidence, the GetSegmentDetection returns segments with confidence values greater than or equal to 50 percent.

Constraints:
Length: 50.0 - 100.0

Class com.amazonaws.services.rekognition.model.StartStreamProcessorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

java.lang.String name

The name of the stream processor to start processing.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.\-]+

startSelector

StreamProcessingStartSelector startSelector

Specifies the starting point in the Kinesis stream to start processing. You can use the producer timestamp or the fragment number. For more information, see Fragment.

This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.

stopSelector

StreamProcessingStopSelector stopSelector

Specifies when to stop processing the stream. You can specify a maximum amount of time to process the video.

This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.

Class com.amazonaws.services.rekognition.model.StartStreamProcessorResult extends java.lang.Object implements Serializable

Serialized Fields

sessionId

java.lang.String sessionId

A unique identifier for the stream processing session.

Class com.amazonaws.services.rekognition.model.StartTechnicalCueDetectionFilter extends java.lang.Object implements Serializable

Serialized Fields

blackFrame

BlackFrame blackFrame

A filter that allows you to control the black frame detection by specifying the black levels and pixel coverage of black pixels in a frame. Videos can come from multiple sources, formats, and time periods, with different standards and varying noise levels for black frames that need to be accounted for.

minSegmentConfidence

java.lang.Float minSegmentConfidence

Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected segment. Confidence represents how certain Amazon Rekognition is that a segment is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any segments with a confidence level lower than this specified value.

If you don't specify MinSegmentConfidence, GetSegmentDetection returns segments with confidence values greater than or equal to 50 percent.

Constraints:
Length: 50.0 - 100.0

Class com.amazonaws.services.rekognition.model.StartTextDetectionFilters extends java.lang.Object implements Serializable

Serialized Fields

regionsOfInterest

java.util.List<RegionOfInterest> regionsOfInterest

Filter focusing on a certain area of the frame. Uses a BoundingBox object to set the region of the screen.

wordFilter

DetectionFilter wordFilter

Filters focusing on qualities of the text, such as confidence or size.

Class com.amazonaws.services.rekognition.model.StartTextDetectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

filters

StartTextDetectionFilters filters

Optional parameters that let you set criteria the text must meet to be included in your response.

jobTag

java.lang.String jobTag

An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.\-:]+

notificationChannel

NotificationChannel notificationChannel

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see Calling Amazon Rekognition Video operations. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic. For more information, see Giving access to multiple Amazon SNS topics.

video

Video video

Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.

Class com.amazonaws.services.rekognition.model.StartTextDetectionResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

Identifier for the text detection job. Use JobId to identify the job in a subsequent call to GetTextDetection.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Class com.amazonaws.services.rekognition.model.StopProjectVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

projectVersionArn

java.lang.String projectVersionArn

The Amazon Resource Name (ARN) of the model version that you want to delete.

This operation requires permissions to perform the rekognition:StopProjectVersion action.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/version\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.StopProjectVersionResult extends java.lang.Object implements Serializable

Serialized Fields

status

java.lang.String status

The current status of the stop operation.

Constraints:
Allowed Values: TRAINING_IN_PROGRESS, TRAINING_COMPLETED, TRAINING_FAILED, STARTING, RUNNING, FAILED, STOPPING, STOPPED, DELETING, COPYING_IN_PROGRESS, COPYING_COMPLETED, COPYING_FAILED

Class com.amazonaws.services.rekognition.model.StopStreamProcessorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

java.lang.String name

The name of a stream processor created by CreateStreamProcessor.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.\-]+

Class com.amazonaws.services.rekognition.model.StopStreamProcessorResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.rekognition.model.StreamProcessingStartSelector extends java.lang.Object implements Serializable

Serialized Fields

kVSStreamStartSelector

KinesisVideoStreamStartSelector kVSStreamStartSelector

Specifies the starting point in the stream to start processing. This can be done with a timestamp or a fragment number in a Kinesis stream.

Class com.amazonaws.services.rekognition.model.StreamProcessingStopSelector extends java.lang.Object implements Serializable

Serialized Fields

maxDurationInSeconds

java.lang.Long maxDurationInSeconds

Specifies the maximum amount of time in seconds that you want the stream to be processed. The largest amount of time is 2 minutes. The default is 10 seconds.

Constraints:
Range: 1 - 120

Class com.amazonaws.services.rekognition.model.StreamProcessor extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

Name of the Amazon Rekognition stream processor.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.\-]+

status

java.lang.String status

Current status of the Amazon Rekognition stream processor.

Constraints:
Allowed Values: STOPPED, STARTING, RUNNING, FAILED, STOPPING, UPDATING

Class com.amazonaws.services.rekognition.model.StreamProcessorDataSharingPreference extends java.lang.Object implements Serializable

Serialized Fields

optIn

java.lang.Boolean optIn

If this option is set to true, you choose to share data with Rekognition to improve model performance.

Class com.amazonaws.services.rekognition.model.StreamProcessorInput extends java.lang.Object implements Serializable

Serialized Fields

kinesisVideoStream

KinesisVideoStream kinesisVideoStream

The Kinesis video stream input stream for the source streaming video.

Class com.amazonaws.services.rekognition.model.StreamProcessorNotificationChannel extends java.lang.Object implements Serializable

Serialized Fields

sNSTopicArn

java.lang.String sNSTopicArn

The Amazon Resource Number (ARN) of the Amazon Amazon Simple Notification Service topic to which Amazon Rekognition posts the completion status.

Constraints:
Pattern: (^arn:aws:sns:.*:\w{12}:.+$)

Class com.amazonaws.services.rekognition.model.StreamProcessorOutput extends java.lang.Object implements Serializable

Serialized Fields

kinesisDataStream

KinesisDataStream kinesisDataStream

The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream processor streams the analysis results.

s3Destination

S3Destination s3Destination

The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.

Class com.amazonaws.services.rekognition.model.StreamProcessorSettings extends java.lang.Object implements Serializable

Serialized Fields

connectedHome

ConnectedHomeSettings connectedHome

Label detection settings to use on a streaming video. Defining the settings is required in the request parameter for CreateStreamProcessor. Including this setting in the CreateStreamProcessor request enables you to use the stream processor for label detection. You can then select what you want the stream processor to detect, such as people or pets. When the stream processor has started, one notification is sent for each object class specified. For example, if packages and pets are selected, one SNS notification is published the first time a package is detected and one SNS notification is published the first time a pet is detected, as well as an end-of-session summary.

faceSearch

FaceSearchSettings faceSearch

Face search settings to use on a streaming video.

Class com.amazonaws.services.rekognition.model.StreamProcessorSettingsForUpdate extends java.lang.Object implements Serializable

Serialized Fields

connectedHomeForUpdate

ConnectedHomeSettingsForUpdate connectedHomeForUpdate

The label detection settings you want to use for your stream processor.

Class com.amazonaws.services.rekognition.model.Summary extends java.lang.Object implements Serializable

Serialized Fields

s3Object

S3Object s3Object

Provides the S3 bucket name and object name.

The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

Class com.amazonaws.services.rekognition.model.Sunglasses extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

Level of confidence in the determination.

Constraints:
Length: 0.0 - 100.0

value

java.lang.Boolean value

Boolean value that indicates whether the face is wearing sunglasses or not.

Class com.amazonaws.services.rekognition.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to assign the tags to.

Constraints:
Length: 20 - 2048

tags

java.util.Map<java.lang.String,java.lang.String> tags

The key-value tags to assign to the resource.

Class com.amazonaws.services.rekognition.model.TagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.rekognition.model.TechnicalCueSegment extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.

Constraints:
Length: 50.0 - 100.0

type

java.lang.String type

The type of the technical cue.

Constraints:
Allowed Values: ColorBars, EndCredits, BlackFrames, OpeningCredits, StudioLogo, Slate, Content

Class com.amazonaws.services.rekognition.model.TestingData extends java.lang.Object implements Serializable

Serialized Fields

assets

java.util.List<Asset> assets

The assets used for testing.

autoCreate

java.lang.Boolean autoCreate

If specified, Amazon Rekognition Custom Labels temporarily splits the training dataset (80%) to create a test dataset (20%) for the training job. After training completes, the test dataset is not stored and the training dataset reverts to its previous size.

Class com.amazonaws.services.rekognition.model.TestingDataResult extends java.lang.Object implements Serializable

Serialized Fields

input

TestingData input

The testing dataset that was supplied for training.

output

TestingData output

The subset of the dataset that was actually tested. Some images (assets) might not be tested due to file formatting and other issues.

validation

ValidationData validation

The location of the data validation manifest. The data validation manifest is created for the test dataset during model training.

Class com.amazonaws.services.rekognition.model.TextDetection extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.

Constraints:
Length: 0.0 - 100.0

detectedText

java.lang.String detectedText

The word or line of text recognized by Amazon Rekognition.

geometry

Geometry geometry

The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.

id

java.lang.Integer id

The identifier for the detected text. The identifier is only unique for a single call to DetectText.

Constraints:
Range: 0 -

parentId

java.lang.Integer parentId

The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null.

Constraints:
Range: 0 -

type

java.lang.String type

The type of text that was detected.

Constraints:
Allowed Values: LINE, WORD

Class com.amazonaws.services.rekognition.model.TextDetectionResult extends java.lang.Object implements Serializable

Serialized Fields

textDetection

TextDetection textDetection

Details about text detected in a video.

timestamp

java.lang.Long timestamp

The time, in milliseconds from the start of the video, that the text was detected.

Class com.amazonaws.services.rekognition.model.ThrottlingException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.TrainingData extends java.lang.Object implements Serializable

Serialized Fields

assets

java.util.List<Asset> assets

A Sagemaker GroundTruth manifest file that contains the training images (assets).

Class com.amazonaws.services.rekognition.model.TrainingDataResult extends java.lang.Object implements Serializable

Serialized Fields

input

TrainingData input

The training assets that you supplied for training.

output

TrainingData output

The images (assets) that were actually trained by Amazon Rekognition Custom Labels.

validation

ValidationData validation

The location of the data validation manifest. The data validation manifest is created for the training dataset during model training.

Class com.amazonaws.services.rekognition.model.UnindexedFace extends java.lang.Object implements Serializable

Serialized Fields

faceDetail

FaceDetail faceDetail

The structure that contains attributes of a face that IndexFacesdetected, but didn't index.

reasons

java.util.List<java.lang.String> reasons

An array of reasons that specify why a face wasn't indexed.

• EXTREME_POSE - The face is at a pose that can't be detected. For example, the head is turned too far away from the camera.

• EXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified by the MaxFaces input parameter for IndexFaces.

• LOW_BRIGHTNESS - The image is too dark.

• LOW_SHARPNESS - The image is too blurry.

• LOW_CONFIDENCE - The face was detected with a low confidence.

• SMALL_BOUNDING_BOX - The bounding box around the face is too small.

Class com.amazonaws.services.rekognition.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to remove the tags from.

Constraints:
Length: 20 - 2048

tagKeys

java.util.List<java.lang.String> tagKeys

A list of the tags that you want to remove.

Class com.amazonaws.services.rekognition.model.UntagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.rekognition.model.UpdateDatasetEntriesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

changes

DatasetChanges changes

The changes that you want to make to the dataset.

datasetArn

java.lang.String datasetArn

The Amazon Resource Name (ARN) of the dataset that you want to update.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/dataset\/(train|test)\/[0-9]+$)

Class com.amazonaws.services.rekognition.model.UpdateDatasetEntriesResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.rekognition.model.UpdateStreamProcessorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dataSharingPreferenceForUpdate

StreamProcessorDataSharingPreference dataSharingPreferenceForUpdate

Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams.

name

java.lang.String name

Name of the stream processor that you want to update.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.\-]+

parametersToDelete

java.util.List<java.lang.String> parametersToDelete

A list of parameters you want to delete from the stream processor.

regionsOfInterestForUpdate

java.util.List<RegionOfInterest> regionsOfInterestForUpdate

Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.

settingsForUpdate

StreamProcessorSettingsForUpdate settingsForUpdate

The stream processor settings that you want to update. Label detection settings can be updated to detect different labels with a different minimum confidence.

Class com.amazonaws.services.rekognition.model.UpdateStreamProcessorResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.rekognition.model.ValidationData extends java.lang.Object implements Serializable

Serialized Fields

assets

java.util.List<Asset> assets

The assets that comprise the validation data.

Class com.amazonaws.services.rekognition.model.Video extends java.lang.Object implements Serializable

Serialized Fields

s3Object

S3Object s3Object

The Amazon S3 bucket name and file name for the video.

Class com.amazonaws.services.rekognition.model.VideoMetadata extends java.lang.Object implements Serializable

Serialized Fields

codec

java.lang.String codec

Type of compression used in the analyzed video.

colorRange

java.lang.String colorRange

A description of the range of luminance values in a video, either LIMITED (16 to 235) or FULL (0 to 255).

Constraints:
Allowed Values: FULL, LIMITED

durationMillis

java.lang.Long durationMillis

Length of the video in milliseconds.

Constraints:
Range: 0 -

format

java.lang.String format

Format of the analyzed video. Possible values are MP4, MOV and AVI.

frameHeight

java.lang.Long frameHeight

Vertical pixel dimension of the video.

Constraints:
Range: 0 -

frameRate

java.lang.Float frameRate

Number of frames per second in the video.

frameWidth

java.lang.Long frameWidth

Horizontal pixel dimension of the video.

Constraints:
Range: 0 -

Class com.amazonaws.services.rekognition.model.VideoTooLargeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rekognition.model.Warning extends java.lang.Object implements Serializable

Serialized Fields

errorCode

java.lang.String errorCode

The new value for the errorCode property for this object.

message

java.lang.String message

The new value for the message property for this object.

sections

java.util.List<Section> sections

The new value for the sections property for this object.

Package com.amazonaws.services.s3

Class com.amazonaws.services.s3.KeyWrapException extends java.lang.SecurityException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.s3.model

Class com.amazonaws.services.s3.model.AbortIncompleteMultipartUpload extends java.lang.Object implements Serializable

Serialized Fields

daysAfterInitiation

int daysAfterInitiation

Indicates the number of days that must pass since initiation for Lifecycle to abort an Incomplete Multipart Upload.

Class com.amazonaws.services.s3.model.AbortMultipartUploadRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the bucket containing the multipart upload to abort

isRequesterPays

boolean isRequesterPays

If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.

key

java.lang.String key

The key of the multipart upload to abort

uploadId

java.lang.String uploadId

The ID of the multipart upload to abort

Class com.amazonaws.services.s3.model.AbstractPutObjectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessControlList

AccessControlList accessControlList

An optional access control list to apply to the new object. If specified, cannedAcl will be ignored.

bucketName

java.lang.String bucketName

The name of an existing bucket, to which this request will upload a new object. You must have Permission.Write permission granted to you in order to upload new objects to a bucket.

cannedAcl

CannedAccessControlList cannedAcl

An optional pre-configured access control policy to use for the new object. Ignored in favor of accessControlList, if present.

file

java.io.File file

The file containing the data to be uploaded to Amazon S3. You must either specify a file or an InputStream containing the data to be uploaded to Amazon S3.

key

java.lang.String key

The key under which to store the new object.

metadata

ObjectMetadata metadata

Optional metadata instructing Amazon S3 how to handle the uploaded data (e.g. custom user metadata, hooks for specifying content type, etc.). If you are uploading from an InputStream, you should always specify metadata with the content size set, otherwise the contents of the InputStream will have to be buffered in memory before they can be sent to Amazon S3, which can have very negative performance impacts.

redirectLocation

java.lang.String redirectLocation

The optional redirect location about an object

sseAwsKeyManagementParams

SSEAwsKeyManagementParams sseAwsKeyManagementParams

The optional AWS Key Management system parameters to be used to encrypt the the object on the server side.

sseCustomerKey

SSECustomerKey sseCustomerKey

The optional customer-provided server-side encryption key to use to encrypt the uploaded object.

storageClass

java.lang.String storageClass

The optional Amazon S3 storage class to use when storing the new object. If not specified, the default, standard storage class will be used.

For more information on Amazon S3 storage classes and available values, see the StorageClass enumeration.

tagging

ObjectTagging tagging

Class com.amazonaws.services.s3.model.AccessControlList extends java.lang.Object implements Serializable

serialVersionUID:

8095040648034788376L

Serialized Fields

grantList

java.util.List<Grant> grantList

grantSet

java.util.Set<Grant> grantSet

isRequesterCharged

boolean isRequesterCharged

Indicate if the requester is charged for conducting this operation from Requester Pays Buckets.

owner

Owner owner

Class com.amazonaws.services.s3.model.AmazonS3Exception extends AmazonServiceException implements Serializable

serialVersionUID:

7573680383273658477L

Serialized Fields

additionalDetails

java.util.Map<java.lang.String,java.lang.String> additionalDetails

Additional information on the exception.

cloudFrontId

java.lang.String cloudFrontId

An S3 specific CloudFront ID in responses from the accelerate endpoint.

errorResponseXml

java.lang.String errorResponseXml

Returns the error XML received in the HTTP Response or null if the exception is constructed from the headers.

extendedRequestId

java.lang.String extendedRequestId

An S3 specific request ID that provides additional debugging information.

Class com.amazonaws.services.s3.model.Bucket extends java.lang.Object implements Serializable

serialVersionUID:

-8646831898339939580L

Serialized Fields

creationDate

java.util.Date creationDate

The date this bucket was created

name

java.lang.String name

The name of this S3 bucket

owner

Owner owner

The details on the owner of this bucket

Class com.amazonaws.services.s3.model.BucketCrossOriginConfiguration extends java.lang.Object implements Serializable

Serialized Fields

rules

java.util.List<CORSRule> rules

Class com.amazonaws.services.s3.model.BucketLifecycleConfiguration extends java.lang.Object implements Serializable

Serialized Fields

rules

java.util.List<BucketLifecycleConfiguration.Rule> rules

Class com.amazonaws.services.s3.model.BucketLifecycleConfiguration.NoncurrentVersionTransition extends java.lang.Object implements Serializable

Serialized Fields

days

int days

The time, in days, between when a new version of the object is uploaded to the bucket and when older version are archived.

storageClass

java.lang.String storageClass

Class com.amazonaws.services.s3.model.BucketLifecycleConfiguration.Rule extends java.lang.Object implements Serializable

Serialized Fields

abortIncompleteMultipartUpload

AbortIncompleteMultipartUpload abortIncompleteMultipartUpload

Specifies the days since the initiation of an Incomplete Multipart Upload that Lifecycle will wait before permanently removing all parts of the upload.

expirationDate

java.util.Date expirationDate

The expiration date of the object and should not coexist with expirationInDays within one lifecycle rule.

expirationInDays

int expirationInDays

The time, in days, between when the object is uploaded to the bucket and when it expires. Should not coexist with expirationDate within one lifecycle rule.

expiredObjectDeleteMarker

boolean expiredObjectDeleteMarker

filter

LifecycleFilter filter

id

java.lang.String id

noncurrentVersionExpirationInDays

int noncurrentVersionExpirationInDays

The time, in days, between when a new version of the object is uploaded to the bucket and when older versions of the object expire.

noncurrentVersionTransitions

java.util.List<BucketLifecycleConfiguration.NoncurrentVersionTransition> noncurrentVersionTransitions

Transition rules for the non current objects in the bucket.

prefix

java.lang.String prefix

status

java.lang.String status

transitions

java.util.List<BucketLifecycleConfiguration.Transition> transitions

Transition rules for the objects in the bucket.

Class com.amazonaws.services.s3.model.BucketLifecycleConfiguration.Transition extends java.lang.Object implements Serializable

Serialized Fields

date

java.util.Date date

The expiration date of the object and should not coexist with expirationInDays within one lifecycle rule.

days

int days

The time, in days, between when the object is uploaded to the bucket and when it expires. Should not coexist with expirationDate within one lifecycle rule.

storageClass

java.lang.String storageClass

Class com.amazonaws.services.s3.model.BucketLoggingConfiguration extends java.lang.Object implements Serializable

Serialized Fields

destinationBucketName

java.lang.String destinationBucketName

logFilePrefix

java.lang.String logFilePrefix

Class com.amazonaws.services.s3.model.BucketNotificationConfiguration extends java.lang.Object implements Serializable

Serialized Fields

configurations

java.util.Map<java.lang.String,NotificationConfiguration> configurations

Class com.amazonaws.services.s3.model.BucketNotificationConfiguration.TopicConfiguration extends TopicConfiguration implements Serializable

Class com.amazonaws.services.s3.model.BucketPolicy extends java.lang.Object implements Serializable

Serialized Fields

policyText

java.lang.String policyText

The raw, policy JSON text, as returned by Amazon S3

Class com.amazonaws.services.s3.model.BucketReplicationConfiguration extends java.lang.Object implements Serializable

Serialized Fields

roleARN

java.lang.String roleARN

The ARN of the IAM role that Amazon S3 assumes while replication.

rules

java.util.Map<java.lang.String,ReplicationRule> rules

Collection of replication rules associated with the Amazon S3 bucket.

Class com.amazonaws.services.s3.model.BucketTaggingConfiguration extends java.lang.Object implements Serializable

Serialized Fields

tagSets

java.util.List<TagSet> tagSets

Class com.amazonaws.services.s3.model.BucketVersioningConfiguration extends java.lang.Object implements Serializable

Serialized Fields

isMfaDeleteEnabled

java.lang.Boolean isMfaDeleteEnabled

Indicates if the optional Multi-Factor Authentication Delete control is enabled for this bucket versioning configuration.

status

java.lang.String status

The current status of versioning

Class com.amazonaws.services.s3.model.BucketWebsiteConfiguration extends java.lang.Object implements Serializable

Serialized Fields

errorDocument

java.lang.String errorDocument

The complete path to the document to serve for 4xx errors.

indexDocumentSuffix

java.lang.String indexDocumentSuffix

The document to serve when a directory is specified (ex: index.html). This path is relative to the requested resource.

redirectAllRequestsTo

RedirectRule redirectAllRequestsTo

Container for redirect information where all requests will be redirect to. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return. .

routingRules

java.util.List<RoutingRule> routingRules

The list of routing rules that can be used for configuring redirects if certain conditions are meet.

Class com.amazonaws.services.s3.model.CanonicalGrantee extends java.lang.Object implements Serializable

Serialized Fields

displayName

java.lang.String displayName

id

java.lang.String id

Class com.amazonaws.services.s3.model.CloudFunctionConfiguration extends NotificationConfiguration implements Serializable

Serialized Fields

cloudFunctionARN

java.lang.String cloudFunctionARN

Deprecated.

The ARN for the lambda function to be invoked.

invocationRoleARN

java.lang.String invocationRoleARN

Deprecated.

The ARN for the IAM role to be used by Amazon S3.

Class com.amazonaws.services.s3.model.CompleteMultipartUploadRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the bucket containing the multipart upload to complete

isRequesterPays

boolean isRequesterPays

If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.

key

java.lang.String key

The key of the multipart upload to complete

partETags

java.util.List<PartETag> partETags

The list of part numbers and ETags to use when completing the multipart upload

uploadId

java.lang.String uploadId

The ID of the multipart upload to complete

Class com.amazonaws.services.s3.model.CompleteMultipartUploadResult extends com.amazonaws.services.s3.internal.SSEResultBase implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the bucket containing the completed multipart upload.

eTag

java.lang.String eTag

The entity tag identifying the new object. An entity tag is an opaque string that changes if and only if an object's data changes.

expirationTime

java.util.Date expirationTime

The time this object expires, or null if it has no expiration

expirationTimeRuleId

java.lang.String expirationTimeRuleId

The expiration rule for this object

isRequesterCharged

boolean isRequesterCharged

Indicate if the requester is charged for conducting this operation from Requester Pays Buckets.

key

java.lang.String key

The key by which the object is stored.

location

java.lang.String location

The URL identifying the new multipart object.

versionId

java.lang.String versionId

The version ID of the new object, only present if versioning has been enabled for the bucket.

Class com.amazonaws.services.s3.model.CopyObjectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessControlList

AccessControlList accessControlList

An optional access control list to apply to the new object. If specified, cannedAcl will be ignored.

cannedACL

CannedAccessControlList cannedACL

Optional field specifying the ACL for the new object

destinationBucketName

java.lang.String destinationBucketName

The name of the bucket to contain the copy of the source object

destinationKey

java.lang.String destinationKey

The key in the destination bucket under which the source object will be copied

destinationSSECustomerKey

SSECustomerKey destinationSSECustomerKey

The optional customer-provided server-side encryption key to use to encrypt the destination object being copied.

isRequesterPays

boolean isRequesterPays

If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.

matchingETagConstraints

java.util.List<java.lang.String> matchingETagConstraints

Optional list of ETag values that constrain the copy request to only be executed if the source object's ETag matches one of the specified ETag values.

modifiedSinceConstraint

java.util.Date modifiedSinceConstraint

Optional field that constrains the copy request to only be executed if the source object has been modified since the specified date.

newObjectMetadata

ObjectMetadata newObjectMetadata

Optional field specifying the object metadata for the new object

newObjectTagging

ObjectTagging newObjectTagging

nonmatchingEtagConstraints

java.util.List<java.lang.String> nonmatchingEtagConstraints

Optional list of ETag values that constrain the copy request to only be executed if the source object's ETag does not match any of the specified ETag constraint values.

redirectLocation

java.lang.String redirectLocation

Optional field specifying the redirect location for the new object

sourceBucketName

java.lang.String sourceBucketName

The name of the bucket containing the object to be copied

sourceKey

java.lang.String sourceKey

The key in the source bucket under which the object to be copied is stored

sourceSSECustomerKey

SSECustomerKey sourceSSECustomerKey

The optional customer-provided server-side encryption key to use to decrypt the source object being copied.

sourceVersionId

java.lang.String sourceVersionId

Optional version Id specifying which version of the source object to copy. If not specified, the most recent version of the source object will be copied.

For more information about enabling versioning for a bucket, see AmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest).

sseAwsKeyManagementParams

SSEAwsKeyManagementParams sseAwsKeyManagementParams

The optional AWS Key Management system parameters to be used to encrypt the the object on the server side.

storageClass

java.lang.String storageClass

The optional Amazon S3 storage class to use when storing the newly copied object. If not specified, the default, standard storage class will be used.

For more information on Amazon S3 storage classes and available values, see the StorageClass enumeration.

unmodifiedSinceConstraint

java.util.Date unmodifiedSinceConstraint

Optional field that constrains the copy request to only be executed if the source object has not been modified since the specified date.

Class com.amazonaws.services.s3.model.CopyObjectResult extends com.amazonaws.services.s3.internal.SSEResultBase implements Serializable

Serialized Fields

etag

java.lang.String etag

The ETag value of the new object

expirationTime

java.util.Date expirationTime

The time this object expires, or null if it has no expiration

expirationTimeRuleId

java.lang.String expirationTimeRuleId

The expiration rule for this object

isRequesterCharged

boolean isRequesterCharged

Indicate if the requester is charged for conducting this operation from Requester Pays Buckets.

lastModifiedDate

java.util.Date lastModifiedDate

The last modified date for the new object

versionId

java.lang.String versionId

The version ID of the new, copied object. This field will only be present if object versioning has been enabled for the bucket to which the object was copied.

Class com.amazonaws.services.s3.model.CopyPartRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationBucketName

java.lang.String destinationBucketName

The name of the bucket to contain the copy of the source object

destinationKey

java.lang.String destinationKey

The key in the destination bucket under which the source object will be copied

destinationSSECustomerKey

SSECustomerKey destinationSSECustomerKey

The optional customer-provided server-side encryption key to use to encrypt the source object part being copied.

firstByte

java.lang.Long firstByte

Optional field that copies the object starting at the given zero-based byte offset. Used with CopyPartRequest.lastByte

lastByte

java.lang.Long lastByte

Optional field that copies the object up to and including the given zero-based byte offset. Used with CopyPartRequest.firstByte.

matchingETagConstraints

java.util.List<java.lang.String> matchingETagConstraints

Optional list of ETag values that constrain the copy request to only be executed if the source object's ETag matches one of the specified ETag values.

modifiedSinceConstraint

java.util.Date modifiedSinceConstraint

Optional field that constrains the copy request to only be executed if the source object has been modified since the specified date.

nonmatchingEtagConstraints

java.util.List<java.lang.String> nonmatchingEtagConstraints

Optional list of ETag values that constrain the copy request to only be executed if the source object's ETag does not match any of the specified ETag constraint values.

partNumber

int partNumber

The part number to copy into.

See Also:

AmazonS3.uploadPart(UploadPartRequest)

sourceBucketName

java.lang.String sourceBucketName

The name of the bucket containing the object to be copied

sourceKey

java.lang.String sourceKey

The key in the source bucket under which the object to be copied is stored

sourceSSECustomerKey

SSECustomerKey sourceSSECustomerKey

The optional customer-provided server-side encryption key to use to decrypt the source object part being copied.

sourceVersionId

java.lang.String sourceVersionId

Optional version Id specifying which version of the source object to copy. If not specified, the most recent version of the source object will be copied.

For more information about enabling versioning for a bucket, see AmazonS3#withBucketVersioningConfiguration(withBucketVersioningConfigurationRequest).

unmodifiedSinceConstraint

java.util.Date unmodifiedSinceConstraint

Optional field that constrains the copy request to only be executed if the source object has not been modified since the specified date.

uploadId

java.lang.String uploadId

The upload id of the multipart upload into which to copy this part.

See Also:

AmazonS3.initiateMultipartUpload(InitiateMultipartUploadRequest)

Class com.amazonaws.services.s3.model.CopyPartResult extends com.amazonaws.services.s3.internal.SSEResultBase implements Serializable

Serialized Fields

etag

java.lang.String etag

The ETag value of the new part

lastModifiedDate

java.util.Date lastModifiedDate

The last modified date for the new part

partNumber

int partNumber

The part number of the copied part

versionId

java.lang.String versionId

The version ID of the source object. This field will only be present if object versioning has been enabled for the bucket from which the object was copied.

Class com.amazonaws.services.s3.model.CryptoConfiguration extends java.lang.Object implements Serializable

serialVersionUID:

-8646831898339939580L

Serialized Fields

cryptoMode

CryptoMode cryptoMode

Deprecated.

cryptoProvider

java.security.Provider cryptoProvider

Deprecated.

ignoreMissingInstructionFile

boolean ignoreMissingInstructionFile

Deprecated.

True to ignore instruction file that cannot be found during a GET operation; false otherwise. Default is true. This property is ignored if the crypto mode is CryptoMode.StrictAuthenticatedEncryption where missing instruction file would always cause security exception.

storageMode

CryptoStorageMode storageMode

Deprecated.

Class com.amazonaws.services.s3.model.DeleteBucketAnalyticsConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

id

java.lang.String id

Class com.amazonaws.services.s3.model.DeleteBucketAnalyticsConfigurationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.s3.model.DeleteBucketCrossOriginConfigurationRequest extends GenericBucketRequest implements Serializable

Class com.amazonaws.services.s3.model.DeleteBucketInventoryConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

id

java.lang.String id

Class com.amazonaws.services.s3.model.DeleteBucketInventoryConfigurationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.s3.model.DeleteBucketLifecycleConfigurationRequest extends GenericBucketRequest implements Serializable

Class com.amazonaws.services.s3.model.DeleteBucketMetricsConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

id

java.lang.String id

Class com.amazonaws.services.s3.model.DeleteBucketMetricsConfigurationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.s3.model.DeleteBucketPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the Amazon S3 bucket whose policy is being deleted.

Class com.amazonaws.services.s3.model.DeleteBucketReplicationConfigurationRequest extends GenericBucketRequest implements Serializable

Class com.amazonaws.services.s3.model.DeleteBucketRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the Amazon S3 bucket to delete.

Class com.amazonaws.services.s3.model.DeleteBucketTaggingConfigurationRequest extends GenericBucketRequest implements Serializable

Class com.amazonaws.services.s3.model.DeleteBucketWebsiteConfigurationRequest extends GenericBucketRequest implements Serializable

Class com.amazonaws.services.s3.model.DeleteObjectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the Amazon S3 bucket containing the object to delete.

isRequesterPays

boolean isRequesterPays

If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.

key

java.lang.String key

The key of the object to delete.

Class com.amazonaws.services.s3.model.DeleteObjectsRequest.KeyVersion extends java.lang.Object implements Serializable

Serialized Fields

key

java.lang.String key

version

java.lang.String version

Class com.amazonaws.services.s3.model.DeleteObjectsResult extends java.lang.Object implements Serializable

Serialized Fields

deletedObjects

java.util.List<DeleteObjectsResult.DeletedObject> deletedObjects

isRequesterCharged

boolean isRequesterCharged

Indicate if the requester is charged for conducting this operation from Requester Pays Buckets.

Class com.amazonaws.services.s3.model.DeleteObjectsResult.DeletedObject extends java.lang.Object implements Serializable

Serialized Fields

deleteMarker

boolean deleteMarker

deleteMarkerVersionId

java.lang.String deleteMarkerVersionId

key

java.lang.String key

versionId

java.lang.String versionId

Class com.amazonaws.services.s3.model.DeleteObjectTaggingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

key

java.lang.String key

versionId

java.lang.String versionId

Class com.amazonaws.services.s3.model.DeleteVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the Amazon S3 bucket containing the version to delete.

key

java.lang.String key

The key of the object version to delete.

mfa

MultiFactorAuthentication mfa

The optional Multi-Factor Authentication information to include with this request. Multi-Factor Authentication is required when deleting a version from a bucket that has enabled MFA Delete in its bucket versioning configuration. See BucketVersioningConfiguration.setMfaDeleteEnabled(Boolean) for more information on MFA Delete.

versionId

java.lang.String versionId

The version ID uniquely identifying which version of the object to delete.

Class com.amazonaws.services.s3.model.EncryptedGetObjectRequest extends GetObjectRequest implements Serializable

Serialized Fields

instructionFileSuffix

java.lang.String instructionFileSuffix

Used to retrieve the S3 encrypted object via instruction file with an explicit suffix. Applicable only if specified (which means non-null and non-blank.)

keyWrapExpected

boolean keyWrapExpected

True if the retrieval of the encrypted object expects the CEK to have been key-wrapped; Default is false.

Note, however, that if CryptoMode.StrictAuthenticatedEncryption is in use, key wrapping is always expected for the CEK regardless.

supplemental

ExtraMaterialsDescription supplemental

Request specific additional material description; never null.

Class com.amazonaws.services.s3.model.EncryptedInitiateMultipartUploadRequest extends InitiateMultipartUploadRequest implements Serializable

Serialized Fields

createEncryptionMaterial

boolean createEncryptionMaterial

True if a new set of encryption material is to be created; false otherwise. Default is true.

materialsDescription

java.util.Map<java.lang.String,java.lang.String> materialsDescription

description of encryption materials to be used with this request.

Class com.amazonaws.services.s3.model.EncryptedPutObjectRequest extends PutObjectRequest implements Serializable

Serialized Fields

materialsDescription

java.util.Map<java.lang.String,java.lang.String> materialsDescription

description of encryption materials to be used with this request.

Class com.amazonaws.services.s3.model.EncryptionMaterials extends java.lang.Object implements Serializable

Serialized Fields

desc

java.util.Map<java.lang.String,java.lang.String> desc

Deprecated.

keyPair

java.security.KeyPair keyPair

Deprecated.

symmetricKey

javax.crypto.SecretKey symmetricKey

Deprecated.

Class com.amazonaws.services.s3.model.ExtraMaterialsDescription extends java.lang.Object implements Serializable

Serialized Fields

extra

java.util.Map<java.lang.String,java.lang.String> extra

Supplemental material descriptions which are unmodifiable.

resolve

ExtraMaterialsDescription.ConflictResolution resolve

Resolution behavior when there are overlapping entries. Defaults to ExtraMaterialsDescription.ConflictResolution.FAIL_FAST.

Class com.amazonaws.services.s3.model.Filter extends java.lang.Object implements Serializable

Serialized Fields

s3KeyFilter

S3KeyFilter s3KeyFilter

Class com.amazonaws.services.s3.model.FilterRule extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

value

java.lang.String value

Class com.amazonaws.services.s3.model.GeneratePresignedUrlRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the bucket involved in this request

contentMd5

java.lang.String contentMd5

The optional Content-MD5 header that will be sent when the presigned URL is accessed

contentType

java.lang.String contentType

The optional Content-Type header that will be sent when the presigned URL is accessed

customQueryParameters

java.util.Map<java.lang.String,java.lang.String> customQueryParameters

Custom query parameters for the request.

expiration

java.util.Date expiration

An optional expiration date at which point the generated pre-signed URL will no longer be accepted by Amazon S3. If not specified, a default value will be supplied.

key

java.lang.String key

The key of the object involved in this request

kmsCmkId

java.lang.String kmsCmkId

Used to specify the KMS CMS Key ID when KMS server side encryption is in use.

method

HttpMethod method

The HTTP method (GET, PUT, DELETE, HEAD) to be used in this request and when the pre-signed URL is used

requestParameters

java.util.Map<java.lang.String,java.lang.String> requestParameters

An optional map of additional parameters to include in the pre-signed URL. Adding additional request parameters enables more advanced pre-signed URLs, such as accessing Amazon S3's torrent resource for an object, or for specifying a version ID when accessing an object.

responseHeaders

ResponseHeaderOverrides responseHeaders

Optional field that overrides headers on the response.

sseAlgorithm

java.lang.String sseAlgorithm

Used to specify the server side encryption algorithm. Null means no server side encryption is in use.

sseCustomerKey

SSECustomerKey sseCustomerKey

Optional customer-provided server-side encryption key to use as part of the generated pre-signed URL.

versionId

java.lang.String versionId

The version ID of the object, only present if versioning has been enabled for the bucket.

zeroByteContent

boolean zeroByteContent

True if the request content is set to zero byte instead of null. This is necessary to make pre-signed URL generation work for multi-part upload initiation using SigV4. Ref: TT0050059365

Class com.amazonaws.services.s3.model.GenericBucketRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

Class com.amazonaws.services.s3.model.GetBucketAccelerateConfigurationRequest extends GenericBucketRequest implements Serializable

Class com.amazonaws.services.s3.model.GetBucketAnalyticsConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

id

java.lang.String id

Class com.amazonaws.services.s3.model.GetBucketAnalyticsConfigurationResult extends java.lang.Object implements Serializable

Serialized Fields

analyticsConfiguration

AnalyticsConfiguration analyticsConfiguration

Class com.amazonaws.services.s3.model.GetBucketCrossOriginConfigurationRequest extends GenericBucketRequest implements Serializable

Class com.amazonaws.services.s3.model.GetBucketInventoryConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

id

java.lang.String id

Class com.amazonaws.services.s3.model.GetBucketLifecycleConfigurationRequest extends GenericBucketRequest implements Serializable

Class com.amazonaws.services.s3.model.GetBucketLocationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the bucket whose location is being requested.

Class com.amazonaws.services.s3.model.GetBucketLoggingConfigurationRequest extends GenericBucketRequest implements Serializable

Class com.amazonaws.services.s3.model.GetBucketMetricsConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

id

java.lang.String id

Class com.amazonaws.services.s3.model.GetBucketMetricsConfigurationResult extends java.lang.Object implements Serializable

Serialized Fields

metricsConfiguration

MetricsConfiguration metricsConfiguration

Class com.amazonaws.services.s3.model.GetBucketNotificationConfigurationRequest extends GenericBucketRequest implements Serializable

Class com.amazonaws.services.s3.model.GetBucketPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the Amazon S3 bucket whose policy is being retrieved.

Class com.amazonaws.services.s3.model.GetBucketReplicationConfigurationRequest extends GenericBucketRequest implements Serializable

Class com.amazonaws.services.s3.model.GetBucketTaggingConfigurationRequest extends GenericBucketRequest implements Serializable

Class com.amazonaws.services.s3.model.GetBucketVersioningConfigurationRequest extends GenericBucketRequest implements Serializable

Class com.amazonaws.services.s3.model.GetObjectAclRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

isRequesterPays

boolean isRequesterPays

If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.

s3ObjectIdBuilder

S3ObjectIdBuilder s3ObjectIdBuilder

Builder of an S3 object identifier. This member field is never null.

Class com.amazonaws.services.s3.model.GetObjectMetadataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the bucket containing the object's whose metadata is being retrieved.

isRequesterPays

boolean isRequesterPays

If enabled, the requester is charged for downloading the metadata from Requester Pays Buckets.

key

java.lang.String key

The key of the object whose metadata is being retrieved.

partNumber

java.lang.Integer partNumber

The optional part number to find the number of parts of an object.

sseCustomerKey

SSECustomerKey sseCustomerKey

The optional customer-provided server-side encryption key to use when retrieving the metadata of a server-side encrypted object.

versionId

java.lang.String versionId

The optional version ID of the object version whose metadata is being retrieved. If not specified, the latest version will be used.

Class com.amazonaws.services.s3.model.GetObjectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

generalProgressListener

ProgressListener generalProgressListener

The optional progress listener for receiving updates about object download status.

isRequesterPays

boolean isRequesterPays

If enabled, the requester is charged for downloading the data from Requester Pays Buckets.

matchingETagConstraints

java.util.List<java.lang.String> matchingETagConstraints

Optional list of ETag values that constrain this request to only be executed if the object's ETag matches one of the specified ETag values.

modifiedSinceConstraint

java.util.Date modifiedSinceConstraint

Optional field that constrains this request to only be executed if the object has been modified since the specified date.

nonmatchingEtagConstraints

java.util.List<java.lang.String> nonmatchingEtagConstraints

Optional list of ETag values that constrain this request to only be executed if the object's ETag does not match any of the specified ETag constraint values.

partNumber

java.lang.Integer partNumber

The part number of the requested part in a multipart object.

range

long[] range

Optional member indicating the byte range of data to retrieve

responseHeaders

ResponseHeaderOverrides responseHeaders

Optional field that overrides headers on the response.

s3ObjectIdBuilder

S3ObjectIdBuilder s3ObjectIdBuilder

Builder of an S3 object identifier. This member field is never null.

sseCustomerKey

SSECustomerKey sseCustomerKey

The optional customer-provided server-side encryption key to use to decrypt this object.

unmodifiedSinceConstraint

java.util.Date unmodifiedSinceConstraint

Optional field that constrains this request to only be executed if the object has not been modified since the specified date.

Class com.amazonaws.services.s3.model.GetObjectTaggingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

key

java.lang.String key

versionId

java.lang.String versionId

Class com.amazonaws.services.s3.model.GetRequestPaymentConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the Amazon S3 bucket.

Class com.amazonaws.services.s3.model.GetS3AccountOwnerRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.s3.model.InitiateMultipartUploadRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessControlList

AccessControlList accessControlList

An optional access control list to apply to the new upload. If specified, cannedAcl will be ignored.

bucketName

java.lang.String bucketName

The name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.

cannedACL

CannedAccessControlList cannedACL

An optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.

isRequesterPays

boolean isRequesterPays

If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.

key

java.lang.String key

The key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.

objectMetadata

ObjectMetadata objectMetadata

Additional information about the new object being created, such as content type, content encoding, user metadata, etc.

redirectLocation

java.lang.String redirectLocation

The optional redirect location for the new object.

sseAwsKeyManagementParams

SSEAwsKeyManagementParams sseAwsKeyManagementParams

The optional AWS Key Management system parameters to be used to encrypt the the object on the server side.

sseCustomerKey

SSECustomerKey sseCustomerKey

The optional customer-provided server-side encryption key to use to encrypt the upload being started.

storageClass

StorageClass storageClass

The optional storage class to use when storing this upload's data in S3. If not specified, the default storage class is used.

tagging

ObjectTagging tagging

Object tagging associated with this request

Class com.amazonaws.services.s3.model.InstructionFileId extends S3ObjectId implements Serializable

Class com.amazonaws.services.s3.model.KMSEncryptionMaterials extends EncryptionMaterials implements Serializable

Class com.amazonaws.services.s3.model.KMSEncryptionMaterialsProvider extends StaticEncryptionMaterialsProvider implements Serializable

Class com.amazonaws.services.s3.model.LambdaConfiguration extends NotificationConfiguration implements Serializable

Serialized Fields

functionARN

java.lang.String functionARN

The ARN for the lambda function to be invoked.

Class com.amazonaws.services.s3.model.ListBucketAnalyticsConfigurationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the Amazon S3 bucket to list the analytics configurations.

continuationToken

java.lang.String continuationToken

Optional parameter which allows list to be continued from a specific point. ContinuationToken is provided in truncated list results.

Class com.amazonaws.services.s3.model.ListBucketAnalyticsConfigurationsResult extends java.lang.Object implements Serializable

Serialized Fields

analyticsConfigurationList

java.util.List<AnalyticsConfiguration> analyticsConfigurationList

continuationToken

java.lang.String continuationToken

Optional parameter which allows list to be continued from a specific point. This is the continuationToken that was sent in the current ListBucketAnalyticsConfigurationsRequest.

isTruncated

boolean isTruncated

Indicates if this is a complete listing, or if the caller needs to make additional requests to Amazon S3 to see the full analytics configuration listing for an S3 bucket.

nextContinuationToken

java.lang.String nextContinuationToken

NextContinuationToken is sent when isTruncated is true meaning there are more analytics configurations in the bucket that can be listed. The next list requests to Amazon S3 can be continued by providing this NextContinuationToken.

Class com.amazonaws.services.s3.model.ListBucketInventoryConfigurationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the Amazon S3 bucket to list the inventory configurations.

continuationToken

java.lang.String continuationToken

Optional parameter which allows list to be continued from a specific point. ContinuationToken is provided in truncated list results.

Class com.amazonaws.services.s3.model.ListBucketInventoryConfigurationsResult extends java.lang.Object implements Serializable

Serialized Fields

continuationToken

java.lang.String continuationToken

Optional parameter which allows list to be continued from a specific point. This is the continuationToken that was sent in the current ListBucketInventoryConfigurationsResult.

inventoryConfigurationList

java.util.List<InventoryConfiguration> inventoryConfigurationList

The list of inventory configurations for a bucket.

isTruncated

boolean isTruncated

Indicates if this is a complete listing, or if the caller needs to make additional requests to Amazon S3 to see the full inventory configuration listing for an S3 bucket.

nextContinuationToken

java.lang.String nextContinuationToken

NextContinuationToken is sent when isTruncated is true meaning there are more inventory configurations in the bucket that can be listed. The next list requests to Amazon S3 can be continued by providing this NextContinuationToken.

Class com.amazonaws.services.s3.model.ListBucketMetricsConfigurationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the Amazon S3 bucket to list the metrics configurations.

continuationToken

java.lang.String continuationToken

Optional parameter which allows list to be continued from a specific point. ContinuationToken is provided in truncated list results.

Class com.amazonaws.services.s3.model.ListBucketMetricsConfigurationsResult extends java.lang.Object implements Serializable

Serialized Fields

continuationToken

java.lang.String continuationToken

Optional parameter which allows list to be continued from a specific point. This is the continuationToken that was sent in the current ListBucketMetricsConfigurationsRequest.

isTruncated

boolean isTruncated

Indicates if this is a complete listing, or if the caller needs to make additional requests to Amazon S3 to see the full metrics configuration listing for an S3 bucket.

metricsConfigurationList

java.util.List<MetricsConfiguration> metricsConfigurationList

The list of metrics configurations for a bucket.

nextContinuationToken

java.lang.String nextContinuationToken

NextContinuationToken is sent when isTruncated is true meaning there are more metrics configurations in the bucket that can be listed. The next list requests to Amazon S3 can be continued by providing this NextContinuationToken.

Class com.amazonaws.services.s3.model.ListNextBatchOfObjectsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

previousObjectListing

ObjectListing previousObjectListing

Class com.amazonaws.services.s3.model.ListNextBatchOfVersionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

previousVersionListing

VersionListing previousVersionListing

Class com.amazonaws.services.s3.model.MultiObjectDeleteException extends AmazonS3Exception implements Serializable

serialVersionUID:

-2004213552302446866L

Serialized Fields

deletedObjects

java.util.List<DeleteObjectsResult.DeletedObject> deletedObjects

errors

java.util.List<MultiObjectDeleteException.DeleteError> errors

Class com.amazonaws.services.s3.model.ObjectListing extends java.lang.Object implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the Amazon S3 bucket containing the listed objects

commonPrefixes

java.util.List<java.lang.String> commonPrefixes

A list of the common prefixes included in this object listing - common prefixes will only be populated for requests that specified a delimiter

delimiter

java.lang.String delimiter

The delimiter parameter originally specified by the caller when this object listing was returned

encodingType

java.lang.String encodingType

The encodingType parameter originally specified by the caller when this object listing was returned.

isTruncated

boolean isTruncated

Indicates if this is a complete listing, or if the caller needs to make additional requests to Amazon S3 to see the full object listing for an S3 bucket

marker

java.lang.String marker

The marker parameter originally specified by the caller when this object listing was returned

maxKeys

int maxKeys

The maxKeys parameter originally specified by the caller when this object listing was returned

nextMarker

java.lang.String nextMarker

The marker to use in order to request the next page of results - only populated if the isTruncated member indicates that this object listing is truncated

objectSummaries

java.util.List<S3ObjectSummary> objectSummaries

A list of summary information describing the objects stored in the bucket

prefix

java.lang.String prefix

The prefix parameter originally specified by the caller when this object listing was returned

Class com.amazonaws.services.s3.model.ObjectMetadata extends java.lang.Object implements Serializable

Serialized Fields

expirationTime

java.util.Date expirationTime

The time this object will expire and be completely removed from S3, or null if this object will never expire.

This and the expiration time rule aren't stored in the metadata map because the header contains both the time and the rule.

expirationTimeRuleId

java.lang.String expirationTimeRuleId

The expiration rule id for this object.

httpExpiresDate

java.util.Date httpExpiresDate

The date when the object is no longer cacheable.

metadata

java.util.Map<java.lang.String,java.lang.Object> metadata

All other (non user custom) headers such as Content-Length, Content-Type, etc.

ongoingRestore

java.lang.Boolean ongoingRestore

Boolean value indicating whether there is an ongoing request to restore an archived copy of this object from Amazon Glacier.

restoreExpirationTime

java.util.Date restoreExpirationTime

The time at which an object that has been temporarily restored from Glacier will expire, and will need to be restored again in order to be accessed. Null if this object has not been restored from Glacier.

userMetadata

java.util.Map<java.lang.String,java.lang.String> userMetadata

Custom user metadata, represented in responses with the x-amz-meta- header prefix

Class com.amazonaws.services.s3.model.ObjectTagging extends java.lang.Object implements Serializable

Serialized Fields

tagSet

java.util.List<Tag> tagSet

Class com.amazonaws.services.s3.model.Owner extends java.lang.Object implements Serializable

serialVersionUID:

-8916731456944569115L

Serialized Fields

displayName

java.lang.String displayName

id

java.lang.String id

Class com.amazonaws.services.s3.model.PutObjectRequest extends AbstractPutObjectRequest implements Serializable

Serialized Fields

isRequesterPays

boolean isRequesterPays

If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.

Class com.amazonaws.services.s3.model.QueueConfiguration extends NotificationConfiguration implements Serializable

Serialized Fields

queueARN

java.lang.String queueARN

The Amazon SQS queue ARN for this configuration.

Class com.amazonaws.services.s3.model.S3KeyFilter extends java.lang.Object implements Serializable

Serialized Fields

filterRules

java.util.List<FilterRule> filterRules

Class com.amazonaws.services.s3.model.S3Object extends java.lang.Object implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the bucket in which this object is contained

isRequesterCharged

boolean isRequesterCharged

Indicates if the requester is charged for downloading the data from Requester Pays Buckets.

key

java.lang.String key

The key under which this object is stored

metadata

ObjectMetadata metadata

The metadata stored by Amazon S3 for this object

redirectLocation

java.lang.String redirectLocation

The redirect location for this object

taggingCount

java.lang.Integer taggingCount

Class com.amazonaws.services.s3.model.S3ObjectId extends java.lang.Object implements Serializable

Serialized Fields

bucket

java.lang.String bucket

key

java.lang.String key

versionId

java.lang.String versionId

Optional and applicable only for get operation.

Class com.amazonaws.services.s3.model.S3ObjectIdBuilder extends java.lang.Object implements Serializable

Serialized Fields

bucket

java.lang.String bucket

key

java.lang.String key

versionId

java.lang.String versionId

Class com.amazonaws.services.s3.model.SetBucketAnalyticsConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

analyticsConfiguration

AnalyticsConfiguration analyticsConfiguration

bucketName

java.lang.String bucketName

Class com.amazonaws.services.s3.model.SetBucketAnalyticsConfigurationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.s3.model.SetBucketInventoryConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

inventoryConfiguration

InventoryConfiguration inventoryConfiguration

Class com.amazonaws.services.s3.model.SetBucketInventoryConfigurationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.s3.model.SetBucketMetricsConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

metricsConfiguration

MetricsConfiguration metricsConfiguration

Class com.amazonaws.services.s3.model.SetBucketMetricsConfigurationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.s3.model.SetObjectAclRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

acl

AccessControlList acl

The custom ACL to apply to the specified object.

bucketName

java.lang.String bucketName

The name of the bucket containing the object whose ACL is being set.

cannedAcl

CannedAccessControlList cannedAcl

The canned ACL to apply to the specified object.

isRequesterPays

boolean isRequesterPays

If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.

key

java.lang.String key

The name of the object whose ACL is being set.

versionId

java.lang.String versionId

The version ID of the object version whose ACL is being set.

Class com.amazonaws.services.s3.model.SetObjectTaggingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

key

java.lang.String key

tagging

ObjectTagging tagging

versionId

java.lang.String versionId

Class com.amazonaws.services.s3.model.SSEAwsKeyManagementParams extends java.lang.Object implements Serializable

Serialized Fields

awsKmsKeyId

java.lang.String awsKmsKeyId

The AWS Key Management Key id to be used for Server Side Encryption of the Amazon S3 object.

Class com.amazonaws.services.s3.model.Tag extends java.lang.Object implements Serializable

Serialized Fields

key

java.lang.String key

value

java.lang.String value

Class com.amazonaws.services.s3.model.TopicConfiguration extends NotificationConfiguration implements Serializable

Serialized Fields

topicARN

java.lang.String topicARN

The Amazon SNS topic ARN for this configuration.

Class com.amazonaws.services.s3.model.UploadObjectRequest extends AbstractPutObjectRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

diskLimit

long diskLimit

Limitation (in bytes) on temporary disk space consumption for this request; must be at least twice the amount of the specified UploadObjectRequest.partSize. The default is 9223372036854775807L.

materialsDescription

java.util.Map<java.lang.String,java.lang.String> materialsDescription

description of encryption materials to be used with this request.

partSize

long partSize

Part size (in bytes). Default is 5242880. This part size will be used as a reference for the multi-part uploads but the physical part size may vary.

uploadPartMetadata

ObjectMetadata uploadPartMetadata

Optional metadata to be included in each upload part requests.

Class com.amazonaws.services.s3.model.UploadPartRequest extends AmazonWebServiceRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

bucketName

java.lang.String bucketName

The name of the bucket containing the initiated multipart upload with which this new part will be associated.

file

java.io.File file

The file containing the data to upload. Exactly one File or InputStream must be specified as the input to this operation.

fileOffset

long fileOffset

The optional offset in the specified file, at which to begin uploading data for this part. If not specified, data will be read from the beginning of the file.

id

int id

The transfer id of this upload part

isLastPart

boolean isLastPart

Allows the caller to indicate if this is the last part being uploaded in a multipart upload.

isRequesterPays

boolean isRequesterPays

If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.

key

java.lang.String key

The key of the initiated multipart upload

mainUploadId

int mainUploadId

The transfer id of the main upload record of this upload part

md5Digest

java.lang.String md5Digest

The optional, but recommended, MD5 hash of the content of this part. If specified, this value will be sent to Amazon S3 to verify the data integrity when the data reaches Amazon S3.

objectMetadata

ObjectMetadata objectMetadata

Additional information about the part being uploaded, such as referrer.

partNumber

int partNumber

The part number describing this part's position relative to the other parts in the multipart upload. Part number must be between 1 and 10,000 (inclusive).

partSize

long partSize

The size of this part, in bytes.

sseCustomerKey

SSECustomerKey sseCustomerKey

The optional customer-provided server-side encryption key to use to encrypt the object part being uploaded.

uploadId

java.lang.String uploadId

The ID of an existing, initiated multipart upload, with which this new part will be associated.

Package com.amazonaws.services.s3.model.analytics

Class com.amazonaws.services.s3.model.analytics.AnalyticsAndOperator extends com.amazonaws.services.s3.model.analytics.AnalyticsNAryOperator implements Serializable

Class com.amazonaws.services.s3.model.analytics.AnalyticsConfiguration extends java.lang.Object implements Serializable

Serialized Fields

filter

AnalyticsFilter filter

id

java.lang.String id

storageClassAnalysis

StorageClassAnalysis storageClassAnalysis

Class com.amazonaws.services.s3.model.analytics.AnalyticsExportDestination extends java.lang.Object implements Serializable

Serialized Fields

s3BucketDestination

AnalyticsS3BucketDestination s3BucketDestination

Class com.amazonaws.services.s3.model.analytics.AnalyticsFilter extends java.lang.Object implements Serializable

Serialized Fields

predicate

AnalyticsFilterPredicate predicate

Class com.amazonaws.services.s3.model.analytics.AnalyticsFilterPredicate extends java.lang.Object implements Serializable

Class com.amazonaws.services.s3.model.analytics.AnalyticsPrefixPredicate extends AnalyticsFilterPredicate implements Serializable

Serialized Fields

prefix

java.lang.String prefix

Class com.amazonaws.services.s3.model.analytics.AnalyticsS3BucketDestination extends java.lang.Object implements Serializable

Serialized Fields

bucketAccountId

java.lang.String bucketAccountId

bucketArn

java.lang.String bucketArn

format

java.lang.String format

prefix

java.lang.String prefix

Class com.amazonaws.services.s3.model.analytics.AnalyticsTagPredicate extends AnalyticsFilterPredicate implements Serializable

Serialized Fields

tag

Tag tag

Class com.amazonaws.services.s3.model.analytics.StorageClassAnalysis extends java.lang.Object implements Serializable

Serialized Fields

dataExport

StorageClassAnalysisDataExport dataExport

Class com.amazonaws.services.s3.model.analytics.StorageClassAnalysisDataExport extends java.lang.Object implements Serializable

Serialized Fields

destination

AnalyticsExportDestination destination

outputSchemaVersion

java.lang.String outputSchemaVersion

Package com.amazonaws.services.s3.model.inventory

Class com.amazonaws.services.s3.model.inventory.InventoryConfiguration extends java.lang.Object implements Serializable

Serialized Fields

destination

InventoryDestination destination

Contains information about where to publish the inventory results.

id

java.lang.String id

The ID used to identify the inventory configuration.

includedObjectVersions

java.lang.String includedObjectVersions

Specifies which object version(s) to included in the inventory results.

inventoryFilter

InventoryFilter inventoryFilter

Specifies an inventory inventoryFilter.

isEnabled

java.lang.Boolean isEnabled

Specifies whether the inventory is enabled or disabled.

optionalFields

java.util.List<java.lang.String> optionalFields

List to store the optional fields that are included in the inventory results.

schedule

InventorySchedule schedule

Specifies the schedule for generating inventory results.

Class com.amazonaws.services.s3.model.inventory.InventoryDestination extends java.lang.Object implements Serializable

Serialized Fields

s3BucketDestination

InventoryS3BucketDestination s3BucketDestination

Contains the S3 destination information of where inventory results are published.

Class com.amazonaws.services.s3.model.inventory.InventoryFilter extends java.lang.Object implements Serializable

Serialized Fields

predicate

InventoryFilterPredicate predicate

Class com.amazonaws.services.s3.model.inventory.InventoryFilterPredicate extends java.lang.Object implements Serializable

Class com.amazonaws.services.s3.model.inventory.InventoryPrefixPredicate extends InventoryFilterPredicate implements Serializable

Serialized Fields

prefix

java.lang.String prefix

Class com.amazonaws.services.s3.model.inventory.InventoryS3BucketDestination extends java.lang.Object implements Serializable

Serialized Fields

accountId

java.lang.String accountId

bucketArn

java.lang.String bucketArn

format

java.lang.String format

prefix

java.lang.String prefix

Class com.amazonaws.services.s3.model.inventory.InventorySchedule extends java.lang.Object implements Serializable

Serialized Fields

frequency

java.lang.String frequency

Specifies how frequently inventory results are produced.

Package com.amazonaws.services.s3.model.lifecycle

Class com.amazonaws.services.s3.model.lifecycle.LifecycleAndOperator extends com.amazonaws.services.s3.model.lifecycle.LifecycleNAryOperator implements Serializable

Class com.amazonaws.services.s3.model.lifecycle.LifecycleFilter extends java.lang.Object implements Serializable

Serialized Fields

predicate

LifecycleFilterPredicate predicate

Class com.amazonaws.services.s3.model.lifecycle.LifecycleFilterPredicate extends java.lang.Object implements Serializable

Class com.amazonaws.services.s3.model.lifecycle.LifecyclePrefixPredicate extends LifecycleFilterPredicate implements Serializable

Serialized Fields

prefix

java.lang.String prefix

Class com.amazonaws.services.s3.model.lifecycle.LifecycleTagPredicate extends LifecycleFilterPredicate implements Serializable

Serialized Fields

tag

Tag tag

Package com.amazonaws.services.s3.model.metrics

Class com.amazonaws.services.s3.model.metrics.MetricsAndOperator extends com.amazonaws.services.s3.model.metrics.MetricsNAryOperator implements Serializable

Class com.amazonaws.services.s3.model.metrics.MetricsConfiguration extends java.lang.Object implements Serializable

Serialized Fields

filter

MetricsFilter filter

id

java.lang.String id

Class com.amazonaws.services.s3.model.metrics.MetricsFilter extends java.lang.Object implements Serializable

Serialized Fields

predicate

MetricsFilterPredicate predicate

Class com.amazonaws.services.s3.model.metrics.MetricsFilterPredicate extends java.lang.Object implements Serializable

Class com.amazonaws.services.s3.model.metrics.MetricsPrefixPredicate extends MetricsFilterPredicate implements Serializable

Serialized Fields

prefix

java.lang.String prefix

Class com.amazonaws.services.s3.model.metrics.MetricsTagPredicate extends MetricsFilterPredicate implements Serializable

Serialized Fields

tag

Tag tag

Package com.amazonaws.services.sagemakerruntime.model

Class com.amazonaws.services.sagemakerruntime.model.InternalFailureException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sagemakerruntime.model.InvokeEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accept

java.lang.String accept

The desired MIME type of the inference in the response.

Constraints:
Length: - 1024

body

java.nio.ByteBuffer body

Provides input data, in the format specified in the ContentType request header. Amazon SageMaker passes all of the data in the body to the model.

For information about the format of the request body, see Common Data Formats—Inference.

Constraints:
Length: - 5242880

contentType

java.lang.String contentType

The MIME type of the input data in the request body.

Constraints:
Length: - 1024

customAttributes

java.lang.String customAttributes

Constraints:
Length: - 1024

endpointName

java.lang.String endpointName

The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

Class com.amazonaws.services.sagemakerruntime.model.InvokeEndpointResult extends java.lang.Object implements Serializable

Serialized Fields

body

java.nio.ByteBuffer body

Includes the inference provided by the model.

For information about the format of the response body, see Common Data Formats—Inference.

Constraints:
Length: - 5242880

contentType

java.lang.String contentType

The MIME type of the inference returned in the response body.

Constraints:
Length: - 1024

customAttributes

java.lang.String customAttributes

Constraints:
Length: - 1024

invokedProductionVariant

java.lang.String invokedProductionVariant

Identifies the production variant that was invoked.

Constraints:
Length: - 1024

Class com.amazonaws.services.sagemakerruntime.model.ModelErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

logStreamArn

java.lang.String logStreamArn

The Amazon Resource Name (ARN) of the log stream.

originalMessage

java.lang.String originalMessage

Original message.

Constraints:
Length: - 2048

originalStatusCode

java.lang.Integer originalStatusCode

Original status code.

Class com.amazonaws.services.sagemakerruntime.model.ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sagemakerruntime.model.ValidationErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.securitytoken.model

Class com.amazonaws.services.securitytoken.model.AssumedRoleUser extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The ARN of the temporary security credentials that are returned from the AssumeRole action. For more information about ARNs and how to use them in policies, see IAM Identifiers in the IAM User Guide.

Constraints:
Length: 20 - 2048
Pattern: [ -~… -퟿-�က0-ჿFF]+

assumedRoleId

java.lang.String assumedRoleId

A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role ID is generated by Amazon Web Services when the role is created.

Constraints:
Length: 2 - 193
Pattern: [\w+=,.@:-]*

Class com.amazonaws.services.securitytoken.model.AssumeRoleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

durationSeconds

java.lang.Integer durationSeconds

The duration, in seconds, of the role session. The value specified can range from 900 seconds (15 minutes) up to the maximum session duration set for the role. The maximum session duration setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting or the administrator setting (whichever is lower), the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails.

Role chaining limits your Amazon Web Services CLI or Amazon Web Services API role session to a maximum of one hour. When you use the AssumeRole API operation to assume a role, you can specify the duration of your role session with the DurationSeconds parameter. You can specify a parameter value of up to 43200 seconds (12 hours), depending on the maximum session duration setting for your role. However, if you assume a role using role chaining and provide a DurationSeconds parameter value greater than one hour, the operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide.

By default, the value is set to 3600 seconds.

The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the Amazon Web Services Management Console in the IAM User Guide.

Constraints:
Range: 900 - 43200

externalId

java.lang.String externalId

A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provided you with an external ID, then provide that value in the ExternalId parameter. This value can be any string, such as a passphrase or account number. A cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the trusting account might send an external ID to the administrator of the trusted account. That way, only someone with the ID can assume the role, rather than everyone in the account. For more information about the external ID, see How to Use an External ID When Granting Access to Your Amazon Web Services Resources to a Third Party in the IAM User Guide.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Constraints:
Length: 2 - 1224
Pattern: [\w+=,.@:\/-]*

policy

java.lang.String policy

An IAM policy in JSON format that you want to use as an inline session policy.

This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list ( through ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.

An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Constraints:
Length: 1 - 2048
Pattern: [ -ÿ]+

policyArns

java.util.List<PolicyDescriptorType> policyArns

The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.

This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

roleArn

java.lang.String roleArn

The Amazon Resource Name (ARN) of the role to assume.

Constraints:
Length: 20 - 2048
Pattern: [ -~… -퟿-�က0-ჿFF]+

roleSessionName

java.lang.String roleSessionName

An identifier for the assumed role session.

Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests that use the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

Constraints:
Length: 2 - 64
Pattern: [\w+=,.@-]*

serialNumber

java.lang.String serialNumber

The identification number of the MFA device that is associated with the user who is making the AssumeRole call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user).

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*

sourceIdentity

java.lang.String sourceIdentity

The source identity specified by the principal that is calling the AssumeRole operation.

You can require users to specify a source identity when they assume a role. You do this by using the sts:SourceIdentity condition key in a role trust policy. You can use source identity information in CloudTrail logs to determine who took actions with a role. You can use the aws:SourceIdentity condition key to further control access to Amazon Web Services resources based on the value of source identity. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-. You cannot use a value that begins with the text aws:. This prefix is reserved for Amazon Web Services internal use.

Constraints:
Length: 2 - 64
Pattern: [\w+=,.@-]*

tags

java.util.List<Tag> tags

A list of session tags that you want to pass. Each session tag consists of a key name and an associated value. For more information about session tags, see Tagging Amazon Web Services STS Sessions in the IAM User Guide.

This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.

An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

You can pass a session tag with the same key as a tag that is already attached to the role. When you do, session tags override a role tag with the same key.

Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate Department and department tag keys. Assume that the role has the Department=Marketing tag and you pass the department=engineering session tag. Department and department are not saved as separate tags, and the session tag passed in the request takes precedence over the role tag.

Additionally, if you used temporary credentials to perform this operation, the new session inherits any transitive session tags from the calling session. If you pass a session tag with the same key as an inherited tag, the operation fails. To view the inherited tags for a session, see the CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the IAM User Guide.

tokenCode

java.lang.String tokenCode

The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. (In other words, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the TokenCode value is missing or expired, the AssumeRole call returns an "access denied" error.

The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.

Constraints:
Length: 6 - 6
Pattern: [\d]*

transitiveTagKeys

java.util.List<java.lang.String> transitiveTagKeys

A list of keys for session tags that you want to set as transitive. If you set a tag key as transitive, the corresponding key and value passes to subsequent sessions in a role chain. For more information, see Chaining Roles with Session Tags in the IAM User Guide.

This parameter is optional. When you set session tags as transitive, the session policy and session tags packed binary limit is not affected.

If you choose not to specify a transitive tag key, then no tags are passed from this session to any subsequent sessions.

Class com.amazonaws.services.securitytoken.model.AssumeRoleResult extends java.lang.Object implements Serializable

Serialized Fields

assumedRoleUser

AssumedRoleUser assumedRoleUser

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.

credentials

Credentials credentials

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

packedPolicySize

java.lang.Integer packedPolicySize

A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.

Constraints:
Range: 0 -

sourceIdentity

java.lang.String sourceIdentity

The source identity specified by the principal that is calling the AssumeRole operation.

You can require users to specify a source identity when they assume a role. You do this by using the sts:SourceIdentity condition key in a role trust policy. You can use source identity information in CloudTrail logs to determine who took actions with a role. You can use the aws:SourceIdentity condition key to further control access to Amazon Web Services resources based on the value of source identity. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

Constraints:
Length: 2 - 64
Pattern: [\w+=,.@-]*

Class com.amazonaws.services.securitytoken.model.AssumeRoleWithSAMLRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

durationSeconds

java.lang.Integer durationSeconds

The duration, in seconds, of the role session. Your role session lasts for the duration that you specify for the DurationSeconds parameter, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide.

By default, the value is set to 3600 seconds.

The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the Amazon Web Services Management Console in the IAM User Guide.

Constraints:
Range: 900 - 43200

policy

java.lang.String policy

An IAM policy in JSON format that you want to use as an inline session policy.

This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list ( through ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.

An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Constraints:
Length: 1 - 2048
Pattern: [ -ÿ]+

policyArns

java.util.List<PolicyDescriptorType> policyArns

The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.

This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

principalArn

java.lang.String principalArn

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

Constraints:
Length: 20 - 2048
Pattern: [ -~… -퟿-�က0-ჿFF]+

roleArn

java.lang.String roleArn

The Amazon Resource Name (ARN) of the role that the caller is assuming.

Constraints:
Length: 20 - 2048
Pattern: [ -~… -퟿-�က0-ჿFF]+

sAMLAssertion

java.lang.String sAMLAssertion

The base64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.

Constraints:
Length: 4 - 100000

Class com.amazonaws.services.securitytoken.model.AssumeRoleWithSAMLResult extends java.lang.Object implements Serializable

Serialized Fields

assumedRoleUser

AssumedRoleUser assumedRoleUser

The identifiers for the temporary security credentials that the operation returns.

audience

java.lang.String audience

The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.

credentials

Credentials credentials

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

issuer

java.lang.String issuer

The value of the Issuer element of the SAML assertion.

nameQualifier

java.lang.String nameQualifier

A hash value based on the concatenation of the following:

• The Issuer response value.

• The Amazon Web Services account ID.

• The friendly name (the last part of the ARN) of the SAML provider in IAM.

The combination of NameQualifier and Subject can be used to uniquely identify a federated user.

The following pseudocode shows how the hash value is calculated:

BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )

packedPolicySize

java.lang.Integer packedPolicySize

A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.

Constraints:
Range: 0 -

sourceIdentity

java.lang.String sourceIdentity

The value in the SourceIdentity attribute in the SAML assertion.

You can require users to set a source identity value when they assume a role. You do this by using the sts:SourceIdentity condition key in a role trust policy. That way, actions that are taken with the role are associated with that user. After the source identity is set, the value cannot be changed. It is present in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your SAML identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithSAML. You do this by adding an attribute to the SAML assertion. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

Constraints:
Length: 2 - 64
Pattern: [\w+=,.@-]*

subject

java.lang.String subject

The value of the NameID element in the Subject element of the SAML assertion.

subjectType

java.lang.String subjectType

The format of the name ID, as defined by the Format attribute in the NameID element of the SAML assertion. Typical examples of the format are transient or persistent.

If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient. If the format includes any other prefix, the format is returned with no modifications.

Class com.amazonaws.services.securitytoken.model.AssumeRoleWithWebIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

durationSeconds

java.lang.Integer durationSeconds

The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide.

By default, the value is set to 3600 seconds.

The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the Amazon Web Services Management Console in the IAM User Guide.

Constraints:
Range: 900 - 43200

policy

java.lang.String policy

An IAM policy in JSON format that you want to use as an inline session policy.

This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list ( through ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.

An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Constraints:
Length: 1 - 2048
Pattern: [ -ÿ]+

policyArns

java.util.List<PolicyDescriptorType> policyArns

The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.

This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

providerId

java.lang.String providerId

The fully qualified host component of the domain name of the OAuth 2.0 identity provider. Do not specify this value for an OpenID Connect identity provider.

Currently www.amazon.com and graph.facebook.com are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.

Do not specify this value for OpenID Connect ID tokens.

Constraints:
Length: 4 - 2048

roleArn

java.lang.String roleArn

The Amazon Resource Name (ARN) of the role that the caller is assuming.

Constraints:
Length: 20 - 2048
Pattern: [ -~… -퟿-�က0-ჿFF]+

roleSessionName

java.lang.String roleSessionName

An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the AssumedRoleUser response element.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

Constraints:
Length: 2 - 64
Pattern: [\w+=,.@-]*

webIdentityToken

java.lang.String webIdentityToken

The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an AssumeRoleWithWebIdentity call.

Constraints:
Length: 4 - 20000

Class com.amazonaws.services.securitytoken.model.AssumeRoleWithWebIdentityResult extends java.lang.Object implements Serializable

Serialized Fields

assumedRoleUser

AssumedRoleUser assumedRoleUser

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.

audience

java.lang.String audience

The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.

credentials

Credentials credentials

The temporary security credentials, which include an access key ID, a secret access key, and a security token.

The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

packedPolicySize

java.lang.Integer packedPolicySize

A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.

Constraints:
Range: 0 -

provider

java.lang.String provider

The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.

sourceIdentity

java.lang.String sourceIdentity

The value of the source identity that is returned in the JSON web token (JWT) from the identity provider.

You can require users to set a source identity value when they assume a role. You do this by using the sts:SourceIdentity condition key in a role trust policy. That way, actions that are taken with the role are associated with that user. After the source identity is set, the value cannot be changed. It is present in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithWebIdentity. You do this by adding a claim to the JSON web token. To learn more about OIDC tokens and claims, see Using Tokens with User Pools in the Amazon Cognito Developer Guide. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

Constraints:
Length: 2 - 64
Pattern: [\w+=,.@-]*

subjectFromWebIdentityToken

java.lang.String subjectFromWebIdentityToken

The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim.

Constraints:
Length: 6 - 255

Class com.amazonaws.services.securitytoken.model.Credentials extends java.lang.Object implements Serializable

Serialized Fields

accessKeyId

java.lang.String accessKeyId

The access key ID that identifies the temporary security credentials.

Constraints:
Length: 16 - 128
Pattern: [\w]*

expiration

java.util.Date expiration

The date on which the current credentials expire.

secretAccessKey

java.lang.String secretAccessKey

The secret access key that can be used to sign requests.

sessionToken

java.lang.String sessionToken

The token that users must pass to the service API to use the temporary credentials.

Class com.amazonaws.services.securitytoken.model.DecodeAuthorizationMessageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

encodedMessage

java.lang.String encodedMessage

The encoded message that was returned with the response.

Constraints:
Length: 1 - 10240

Class com.amazonaws.services.securitytoken.model.DecodeAuthorizationMessageResult extends java.lang.Object implements Serializable

Serialized Fields

decodedMessage

java.lang.String decodedMessage

The API returns a response with the decoded message.

Class com.amazonaws.services.securitytoken.model.ExpiredTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.securitytoken.model.FederatedUser extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in the IAM User Guide.

Constraints:
Length: 20 - 2048
Pattern: [ -~… -퟿-�က0-ჿFF]+

federatedUserId

java.lang.String federatedUserId

The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.

Constraints:
Length: 2 - 193
Pattern: [\w+=,.@\:-]*

Class com.amazonaws.services.securitytoken.model.GetAccessKeyInfoRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessKeyId

java.lang.String accessKeyId

The identifier of an access key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper- or lowercase letter or digit.

Constraints:
Length: 16 - 128
Pattern: [\w]*

Class com.amazonaws.services.securitytoken.model.GetAccessKeyInfoResult extends java.lang.Object implements Serializable

Serialized Fields

account

java.lang.String account

The number used to identify the Amazon Web Services account.

Class com.amazonaws.services.securitytoken.model.GetCallerIdentityRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.securitytoken.model.GetCallerIdentityResult extends java.lang.Object implements Serializable

Serialized Fields

account

java.lang.String account

The Amazon Web Services account ID number of the account that owns or contains the calling entity.

arn

java.lang.String arn

The Amazon Web Services ARN associated with the calling entity.

Constraints:
Length: 20 - 2048
Pattern: [ -~… -퟿-�က0-ჿFF]+

userId

java.lang.String userId

The unique identifier of the calling entity. The exact value depends on the type of entity that is making the call. The values returned are those listed in the aws:userid column in the Principal table found on the Policy Variables reference page in the IAM User Guide.

Class com.amazonaws.services.securitytoken.model.GetFederationTokenRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

durationSeconds

java.lang.Integer durationSeconds

The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions obtained using Amazon Web Services account root user credentials are restricted to a maximum of 3,600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using root user credentials defaults to one hour.

Constraints:
Range: 900 - 129600

name

java.lang.String name

The name of the federated user. The name is used as an identifier for the temporary security credentials (such as Bob). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*

policy

java.lang.String policy

An IAM policy in JSON format that you want to use as an inline session policy.

You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies.

This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions.

When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide.

The resulting credentials can be used to access a resource that has a resource-based policy. If that policy specifically references the federated user session in the Principal element of the policy, the session has the permissions allowed by the policy. These permissions are granted in addition to the permissions that are granted by the session policies.

The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list ( through ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.

An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

Constraints:
Length: 1 - 2048
Pattern: [ -ÿ]+

policyArns

java.util.List<PolicyDescriptorType> policyArns

The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session policy. The policies must exist in the same account as the IAM user that is requesting federated access.

You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions.

When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide.

The resulting credentials can be used to access a resource that has a resource-based policy. If that policy specifically references the federated user session in the Principal element of the policy, the session has the permissions allowed by the policy. These permissions are granted in addition to the permissions that are granted by the session policies.

An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

tags

java.util.List<Tag> tags

A list of session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.

This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.

An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The PackedPolicySize response element indicates by percentage how close the policies and tags for your request are to the upper size limit.

You can pass a session tag with the same key as a tag that is already attached to the user you are federating. When you do, session tags override a user tag with the same key.

Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate Department and department tag keys. Assume that the role has the Department=Marketing tag and you pass the department=engineering session tag. Department and department are not saved as separate tags, and the session tag passed in the request takes precedence over the role tag.

Class com.amazonaws.services.securitytoken.model.GetFederationTokenResult extends java.lang.Object implements Serializable

Serialized Fields

credentials

Credentials credentials

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

federatedUser

FederatedUser federatedUser

Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.

packedPolicySize

java.lang.Integer packedPolicySize

A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.

Constraints:
Range: 0 -

Class com.amazonaws.services.securitytoken.model.GetSessionTokenRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

durationSeconds

java.lang.Integer durationSeconds

The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for Amazon Web Services account owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one hour, the session for Amazon Web Services account owners defaults to one hour.

Constraints:
Range: 900 - 129600

serialNumber

java.lang.String serialNumber

The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the Amazon Web Services Management Console and viewing the user's security credentials.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*

tokenCode

java.lang.String tokenCode

The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an "access denied" response when requesting resources that require MFA authentication.

The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.

Constraints:
Length: 6 - 6
Pattern: [\d]*

Class com.amazonaws.services.securitytoken.model.GetSessionTokenResult extends java.lang.Object implements Serializable

Serialized Fields

credentials

Credentials credentials

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

Class com.amazonaws.services.securitytoken.model.IDPCommunicationErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.securitytoken.model.IDPRejectedClaimException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.securitytoken.model.InvalidAuthorizationMessageException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.securitytoken.model.InvalidIdentityTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.securitytoken.model.MalformedPolicyDocumentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.securitytoken.model.PackedPolicyTooLargeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.securitytoken.model.PolicyDescriptorType extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the IAM managed policy to use as a session policy for the role. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

Constraints:
Length: 20 - 2048
Pattern: [ -~… -퟿-�က0-ჿFF]+

Class com.amazonaws.services.securitytoken.model.RegionDisabledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.securitytoken.model.Tag extends java.lang.Object implements Serializable

Serialized Fields

key

java.lang.String key

The key for a session tag.

You can pass up to 50 session tags. The plain text session tag keys can’t exceed 128 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]+

value

java.lang.String value

The value for a session tag.

You can pass up to 50 session tags. The plain text session tag values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.

Constraints:
Length: 0 - 256
Pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]*

Package com.amazonaws.services.simpledb.model

Class com.amazonaws.services.simpledb.model.Attribute extends java.lang.Object implements Serializable

Serialized Fields

alternateNameEncoding

java.lang.String alternateNameEncoding

alternateValueEncoding

java.lang.String alternateValueEncoding

name

java.lang.String name

The name of the attribute.

value

java.lang.String value

The value of the attribute.

Class com.amazonaws.services.simpledb.model.AttributeDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

boxUsage

java.lang.Float boxUsage

Class com.amazonaws.services.simpledb.model.BatchDeleteAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

java.lang.String domainName

The name of the domain in which the attributes are being deleted.

items

com.amazonaws.internal.ListWithAutoConstructFlag<DeletableItem> items

A list of items on which to perform the operation.

Class com.amazonaws.services.simpledb.model.BatchPutAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

java.lang.String domainName

The name of the domain in which the attributes are being stored.

items

com.amazonaws.internal.ListWithAutoConstructFlag<ReplaceableItem> items

A list of items on which to perform the operation.

Class com.amazonaws.services.simpledb.model.CreateDomainRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

java.lang.String domainName

The name of the domain to create. The name can range between 3 and 255 characters and can contain the following characters: a-z, A-Z, 0-9, '_', '-', and '.'.

Class com.amazonaws.services.simpledb.model.DeletableItem extends java.lang.Object implements Serializable

Serialized Fields

attributes

com.amazonaws.internal.ListWithAutoConstructFlag<Attribute> attributes

name

java.lang.String name

Class com.amazonaws.services.simpledb.model.DeleteAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

com.amazonaws.internal.ListWithAutoConstructFlag<Attribute> attributes

A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items.

domainName

java.lang.String domainName

The name of the domain in which to perform the operation.

expected

UpdateCondition expected

The update condition which, if specified, determines whether the specified attributes will be deleted or not. The update condition must be satisfied in order for this request to be processed and the attributes to be deleted.

itemName

java.lang.String itemName

The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs.

Class com.amazonaws.services.simpledb.model.DeleteDomainRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

java.lang.String domainName

The name of the domain to delete.

Class com.amazonaws.services.simpledb.model.DomainMetadataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

java.lang.String domainName

The name of the domain for which to display the metadata of.

Class com.amazonaws.services.simpledb.model.DomainMetadataResult extends java.lang.Object implements Serializable

Serialized Fields

attributeNameCount

java.lang.Integer attributeNameCount

The number of unique attribute names in the domain.

attributeNamesSizeBytes

java.lang.Long attributeNamesSizeBytes

The total size of all unique attribute names in the domain, in bytes.

attributeValueCount

java.lang.Integer attributeValueCount

The number of all attribute name/value pairs in the domain.

attributeValuesSizeBytes

java.lang.Long attributeValuesSizeBytes

The total size of all attribute values in the domain, in bytes.

itemCount

java.lang.Integer itemCount

The number of all items in the domain.

itemNamesSizeBytes

java.lang.Long itemNamesSizeBytes

The total size of all item names in the domain, in bytes.

timestamp

java.lang.Integer timestamp

The data and time when metadata was calculated in Epoch (UNIX) time.

Class com.amazonaws.services.simpledb.model.DuplicateItemNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

boxUsage

java.lang.Float boxUsage

Class com.amazonaws.services.simpledb.model.GetAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeNames

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> attributeNames

The names of the attributes.

consistentRead

java.lang.Boolean consistentRead

Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If true, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read.

domainName

java.lang.String domainName

The name of the domain in which to perform the operation.

itemName

java.lang.String itemName

The name of the item.

Class com.amazonaws.services.simpledb.model.GetAttributesResult extends java.lang.Object implements Serializable

Serialized Fields

attributes

com.amazonaws.internal.ListWithAutoConstructFlag<Attribute> attributes

The list of attributes returned by the operation.

Class com.amazonaws.services.simpledb.model.InvalidNextTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

boxUsage

java.lang.Float boxUsage

Class com.amazonaws.services.simpledb.model.InvalidNumberPredicatesException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

boxUsage

java.lang.Float boxUsage

Class com.amazonaws.services.simpledb.model.InvalidNumberValueTestsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

boxUsage

java.lang.Float boxUsage

Class com.amazonaws.services.simpledb.model.InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

boxUsage

java.lang.Float boxUsage

Class com.amazonaws.services.simpledb.model.InvalidQueryExpressionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

boxUsage

java.lang.Float boxUsage

Class com.amazonaws.services.simpledb.model.Item extends java.lang.Object implements Serializable

Serialized Fields

alternateNameEncoding

java.lang.String alternateNameEncoding

attributes

com.amazonaws.internal.ListWithAutoConstructFlag<Attribute> attributes

A list of attributes.

name

java.lang.String name

The name of the item.

Class com.amazonaws.services.simpledb.model.ListDomainsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxNumberOfDomains

java.lang.Integer maxNumberOfDomains

The maximum number of domain names you want returned. The range is 1 to 100. The default setting is 100.

nextToken

java.lang.String nextToken

A string informing Amazon SimpleDB where to start the next list of domain names.

Class com.amazonaws.services.simpledb.model.ListDomainsResult extends java.lang.Object implements Serializable

Serialized Fields

domainNames

com.amazonaws.internal.ListWithAutoConstructFlag<java.lang.String> domainNames

A list of domain names that match the expression.

nextToken

java.lang.String nextToken

An opaque token indicating that there are more domains than the specified MaxNumberOfDomains still available.

Class com.amazonaws.services.simpledb.model.MissingParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

boxUsage

java.lang.Float boxUsage

Class com.amazonaws.services.simpledb.model.NoSuchDomainException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

boxUsage

java.lang.Float boxUsage

Class com.amazonaws.services.simpledb.model.NumberDomainAttributesExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

boxUsage

java.lang.Float boxUsage

Class com.amazonaws.services.simpledb.model.NumberDomainBytesExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

boxUsage

java.lang.Float boxUsage

Class com.amazonaws.services.simpledb.model.NumberDomainsExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

boxUsage

java.lang.Float boxUsage

Class com.amazonaws.services.simpledb.model.NumberItemAttributesExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

boxUsage

java.lang.Float boxUsage

Class com.amazonaws.services.simpledb.model.NumberSubmittedAttributesExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

boxUsage

java.lang.Float boxUsage

Class com.amazonaws.services.simpledb.model.NumberSubmittedItemsExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

boxUsage

java.lang.Float boxUsage

Class com.amazonaws.services.simpledb.model.PutAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

com.amazonaws.internal.ListWithAutoConstructFlag<ReplaceableAttribute> attributes

The list of attributes.

domainName

java.lang.String domainName

The name of the domain in which to perform the operation.

expected

UpdateCondition expected

The update condition which, if specified, determines whether the specified attributes will be updated or not. The update condition must be satisfied in order for this request to be processed and the attributes to be updated.

itemName

java.lang.String itemName

The name of the item.

Class com.amazonaws.services.simpledb.model.ReplaceableAttribute extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the replaceable attribute.

replace

java.lang.Boolean replace

A flag specifying whether or not to replace the attribute/value pair or to add a new attribute/value pair. The default setting is false.

value

java.lang.String value

The value of the replaceable attribute.

Class com.amazonaws.services.simpledb.model.ReplaceableItem extends java.lang.Object implements Serializable

Serialized Fields

attributes

com.amazonaws.internal.ListWithAutoConstructFlag<ReplaceableAttribute> attributes

The list of attributes for a replaceable item.

name

java.lang.String name

The name of the replaceable item.

Class com.amazonaws.services.simpledb.model.RequestTimeoutException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

boxUsage

java.lang.Float boxUsage

Class com.amazonaws.services.simpledb.model.SelectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

consistentRead

java.lang.Boolean consistentRead

Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If true, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read.

nextToken

java.lang.String nextToken

A string informing Amazon SimpleDB where to start the next list of ItemNames.

selectExpression

java.lang.String selectExpression

The expression used to query the domain.

Class com.amazonaws.services.simpledb.model.SelectResult extends java.lang.Object implements Serializable

Serialized Fields

items

com.amazonaws.internal.ListWithAutoConstructFlag<Item> items

A list of items that match the select expression.

nextToken

java.lang.String nextToken

An opaque token indicating that more items than MaxNumberOfItems were matched, the response size exceeded 1 megabyte, or the execution time exceeded 5 seconds.

Class com.amazonaws.services.simpledb.model.TooManyRequestedAttributesException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

boxUsage

java.lang.Float boxUsage

Class com.amazonaws.services.simpledb.model.UpdateCondition extends java.lang.Object implements Serializable

Serialized Fields

exists

java.lang.Boolean exists

A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied. Specify true if the attribute must exist for the update condition to be satisfied. Specify false if the attribute should not exist in order for the update condition to be satisfied.

name

java.lang.String name

The name of the attribute involved in the condition.

value

java.lang.String value

The value of an attribute. This value can only be specified when the Exists parameter is equal to true.

Package com.amazonaws.services.simpleemail.model

Class com.amazonaws.services.simpleemail.model.AccountSendingPausedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.simpleemail.model.AddHeaderAction extends java.lang.Object implements Serializable

Serialized Fields

headerName

java.lang.String headerName

The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

headerValue

java.lang.String headerValue

Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").

Class com.amazonaws.services.simpleemail.model.AlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

name

java.lang.String name

Indicates that a resource could not be created because the resource name already exists.

Class com.amazonaws.services.simpleemail.model.Body extends java.lang.Object implements Serializable

Serialized Fields

html

Content html

The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.

text

Content text

The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).

Class com.amazonaws.services.simpleemail.model.BounceAction extends java.lang.Object implements Serializable

Serialized Fields

message

java.lang.String message

Human-readable text to include in the bounce message.

sender

java.lang.String sender

The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.

smtpReplyCode

java.lang.String smtpReplyCode

The SMTP reply code, as defined by RFC 5321.

statusCode

java.lang.String statusCode

The SMTP enhanced status code, as defined by RFC 3463.

topicArn

java.lang.String topicArn

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Class com.amazonaws.services.simpleemail.model.BouncedRecipientInfo extends java.lang.Object implements Serializable

Serialized Fields

bounceType

java.lang.String bounceType

The reason for the bounce. You must provide either this parameter or RecipientDsnFields.

Constraints:
Allowed Values: DoesNotExist, MessageTooLarge, ExceededQuota, ContentRejected, Undefined, TemporaryFailure

recipient

java.lang.String recipient

The email address of the recipient of the bounced email.

recipientArn

java.lang.String recipientArn

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide.

recipientDsnFields

RecipientDsnFields recipientDsnFields

Recipient-related DSN fields, most of which would normally be filled in automatically when provided with a BounceType. You must provide either this parameter or BounceType.

Class com.amazonaws.services.simpleemail.model.BulkEmailDestination extends java.lang.Object implements Serializable

Serialized Fields

destination

Destination destination

Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.

replacementTags

java.util.List<MessageTag> replacementTags

A list of tags, in the form of name/value pairs, to apply to an email that you send using SendBulkTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

replacementTemplateData

java.lang.String replacementTemplateData

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Constraints:
Length: - 262144

Class com.amazonaws.services.simpleemail.model.BulkEmailDestinationStatus extends java.lang.Object implements Serializable

Serialized Fields

error

java.lang.String error

A description of an error that prevented a message being sent using the SendBulkTemplatedEmail operation.

messageId

java.lang.String messageId

The unique message identifier returned from the SendBulkTemplatedEmail operation.

status

java.lang.String status

The status of a message sent using the SendBulkTemplatedEmail operation.

Possible values for this parameter include:

• Success: Amazon SES accepted the message, and will attempt to deliver it to the recipients.

• MessageRejected: The message was rejected because it contained a virus.

• MailFromDomainNotVerified: The sender's email address or domain was not verified.

• ConfigurationSetDoesNotExist: The configuration set you specified does not exist.

• TemplateDoesNotExist: The template you specified does not exist.

• AccountSuspended: Your account has been shut down because of issues related to your email sending practices.

• AccountThrottled: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.

• AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.

• InvalidSendingPoolName: The configuration set you specified refers to an IP pool that does not exist.

• AccountSendingPaused: Email sending for the Amazon SES account was disabled using the UpdateAccountSendingEnabled operation.

• ConfigurationSetSendingPaused: Email sending for this configuration set was disabled using the UpdateConfigurationSetSendingEnabled operation.

• InvalidParameterValue: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.

• TransientFailure: Amazon SES was unable to process your request because of a temporary issue.

• Failed: Amazon SES was unable to process your request. See the error message for additional information.

Constraints:
Allowed Values: Success, MessageRejected, MailFromDomainNotVerified, ConfigurationSetDoesNotExist, TemplateDoesNotExist, AccountSuspended, AccountThrottled, AccountDailyQuotaExceeded, InvalidSendingPoolName, AccountSendingPaused, ConfigurationSetSendingPaused, InvalidParameterValue, TransientFailure, Failed

Class com.amazonaws.services.simpleemail.model.CannotDeleteException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

name

java.lang.String name

Indicates that a resource could not be deleted because no resource with the specified name exists.

Class com.amazonaws.services.simpleemail.model.CloneReceiptRuleSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

originalRuleSetName

java.lang.String originalRuleSetName

The name of the rule set to clone.

ruleSetName

java.lang.String ruleSetName

The name of the rule set to create. The name must:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Start and end with a letter or number.

• Contain less than 64 characters.

Class com.amazonaws.services.simpleemail.model.CloneReceiptRuleSetResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.CloudWatchDestination extends java.lang.Object implements Serializable

Serialized Fields

dimensionConfigurations

java.util.List<CloudWatchDimensionConfiguration> dimensionConfigurations

A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.

Class com.amazonaws.services.simpleemail.model.CloudWatchDimensionConfiguration extends java.lang.Object implements Serializable

Serialized Fields

defaultDimensionValue

java.lang.String defaultDimensionValue

The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain less than 256 characters.

dimensionName

java.lang.String dimensionName

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain less than 256 characters.

dimensionValueSource

java.lang.String dimensionValueSource

The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon SES to use your own email headers, choose emailHeader.

Constraints:
Allowed Values: messageTag, emailHeader, linkTag

Class com.amazonaws.services.simpleemail.model.ConfigurationSet extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the configuration set. The name must meet the following requirements:

• Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain 64 characters or fewer.

Class com.amazonaws.services.simpleemail.model.ConfigurationSetAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

configurationSetName

java.lang.String configurationSetName

Indicates that the configuration set does not exist.

Class com.amazonaws.services.simpleemail.model.ConfigurationSetDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

configurationSetName

java.lang.String configurationSetName

Indicates that the configuration set does not exist.

Class com.amazonaws.services.simpleemail.model.ConfigurationSetSendingPausedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

configurationSetName

java.lang.String configurationSetName

The name of the configuration set for which email sending is disabled.

Class com.amazonaws.services.simpleemail.model.Content extends java.lang.Object implements Serializable

Serialized Fields

charset

java.lang.String charset

The character set of the content.

data

java.lang.String data

The textual data of the content.

Class com.amazonaws.services.simpleemail.model.CreateConfigurationSetEventDestinationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationSetName

java.lang.String configurationSetName

The name of the configuration set that the event destination should be associated with.

eventDestination

EventDestination eventDestination

An object that describes the AWS service that email sending event information will be published to.

Class com.amazonaws.services.simpleemail.model.CreateConfigurationSetEventDestinationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.CreateConfigurationSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationSet

ConfigurationSet configurationSet

A data structure that contains the name of the configuration set.

Class com.amazonaws.services.simpleemail.model.CreateConfigurationSetResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.CreateConfigurationSetTrackingOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationSetName

java.lang.String configurationSetName

The name of the configuration set that the tracking options should be associated with.

trackingOptions

TrackingOptions trackingOptions

A domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.

For more information, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.

Class com.amazonaws.services.simpleemail.model.CreateConfigurationSetTrackingOptionsResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.CreateCustomVerificationEmailTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

failureRedirectionURL

java.lang.String failureRedirectionURL

The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

fromEmailAddress

java.lang.String fromEmailAddress

The email address that the custom verification email is sent from.

successRedirectionURL

java.lang.String successRedirectionURL

The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

templateContent

java.lang.String templateContent

The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.

templateName

java.lang.String templateName

The name of the custom verification email template.

templateSubject

java.lang.String templateSubject

The subject line of the custom verification email.

Class com.amazonaws.services.simpleemail.model.CreateReceiptFilterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

ReceiptFilter filter

A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it.

Class com.amazonaws.services.simpleemail.model.CreateReceiptFilterResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.CreateReceiptRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

after

java.lang.String after

The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list.

rule

ReceiptRule rule

A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.

ruleSetName

java.lang.String ruleSetName

The name of the rule set that the receipt rule will be added to.

Class com.amazonaws.services.simpleemail.model.CreateReceiptRuleResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.CreateReceiptRuleSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleSetName

java.lang.String ruleSetName

The name of the rule set to create. The name must:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Start and end with a letter or number.

• Contain less than 64 characters.

Class com.amazonaws.services.simpleemail.model.CreateReceiptRuleSetResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.CreateTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

template

Template template

The content of the email, composed of a subject line, an HTML part, and a text-only part.

Class com.amazonaws.services.simpleemail.model.CreateTemplateResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.CustomVerificationEmailInvalidContentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.simpleemail.model.CustomVerificationEmailTemplate extends java.lang.Object implements Serializable

Serialized Fields

failureRedirectionURL

java.lang.String failureRedirectionURL

The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

fromEmailAddress

java.lang.String fromEmailAddress

The email address that the custom verification email is sent from.

successRedirectionURL

java.lang.String successRedirectionURL

The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

templateName

java.lang.String templateName

The name of the custom verification email template.

templateSubject

java.lang.String templateSubject

The subject line of the custom verification email.

Class com.amazonaws.services.simpleemail.model.CustomVerificationEmailTemplateAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

customVerificationEmailTemplateName

java.lang.String customVerificationEmailTemplateName

Indicates that the provided custom verification email template with the specified template name already exists.

Class com.amazonaws.services.simpleemail.model.CustomVerificationEmailTemplateDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

customVerificationEmailTemplateName

java.lang.String customVerificationEmailTemplateName

Indicates that the provided custom verification email template does not exist.

Class com.amazonaws.services.simpleemail.model.DeleteConfigurationSetEventDestinationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationSetName

java.lang.String configurationSetName

The name of the configuration set from which to delete the event destination.

eventDestinationName

java.lang.String eventDestinationName

The name of the event destination to delete.

Class com.amazonaws.services.simpleemail.model.DeleteConfigurationSetEventDestinationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.DeleteConfigurationSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationSetName

java.lang.String configurationSetName

The name of the configuration set to delete.

Class com.amazonaws.services.simpleemail.model.DeleteConfigurationSetResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.DeleteConfigurationSetTrackingOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationSetName

java.lang.String configurationSetName

The name of the configuration set from which you want to delete the tracking options.

Class com.amazonaws.services.simpleemail.model.DeleteConfigurationSetTrackingOptionsResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.DeleteCustomVerificationEmailTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

templateName

java.lang.String templateName

The name of the custom verification email template that you want to delete.

Class com.amazonaws.services.simpleemail.model.DeleteIdentityPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identity

java.lang.String identity

The identity that is associated with the policy that you want to delete. You can specify the identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

policyName

java.lang.String policyName

The name of the policy to be deleted.

Constraints:
Length: 1 - 64

Class com.amazonaws.services.simpleemail.model.DeleteIdentityPolicyResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.DeleteIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identity

java.lang.String identity

The identity to be removed from the list of identities for the AWS Account.

Class com.amazonaws.services.simpleemail.model.DeleteIdentityResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.DeleteReceiptFilterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filterName

java.lang.String filterName

The name of the IP address filter to delete.

Class com.amazonaws.services.simpleemail.model.DeleteReceiptFilterResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.DeleteReceiptRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleName

java.lang.String ruleName

The name of the receipt rule to delete.

ruleSetName

java.lang.String ruleSetName

The name of the receipt rule set that contains the receipt rule to delete.

Class com.amazonaws.services.simpleemail.model.DeleteReceiptRuleResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.DeleteReceiptRuleSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleSetName

java.lang.String ruleSetName

The name of the receipt rule set to delete.

Class com.amazonaws.services.simpleemail.model.DeleteReceiptRuleSetResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.DeleteTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

templateName

java.lang.String templateName

The name of the template to be deleted.

Class com.amazonaws.services.simpleemail.model.DeleteTemplateResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.DeleteVerifiedEmailAddressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

emailAddress

java.lang.String emailAddress

An email address to be removed from the list of verified addresses.

Class com.amazonaws.services.simpleemail.model.DeliveryOptions extends java.lang.Object implements Serializable

Serialized Fields

tlsPolicy

java.lang.String tlsPolicy

Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.

Constraints:
Allowed Values: Require, Optional

Class com.amazonaws.services.simpleemail.model.DescribeActiveReceiptRuleSetRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.simpleemail.model.DescribeActiveReceiptRuleSetResult extends java.lang.Object implements Serializable

Serialized Fields

metadata

ReceiptRuleSetMetadata metadata

The metadata for the currently active receipt rule set. The metadata consists of the rule set name and a timestamp of when the rule set was created.

rules

java.util.List<ReceiptRule> rules

The receipt rules that belong to the active rule set.

Class com.amazonaws.services.simpleemail.model.DescribeConfigurationSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationSetAttributeNames

java.util.List<java.lang.String> configurationSetAttributeNames

A list of configuration set attributes to return.

configurationSetName

java.lang.String configurationSetName

The name of the configuration set to describe.

Class com.amazonaws.services.simpleemail.model.DescribeConfigurationSetResult extends java.lang.Object implements Serializable

Serialized Fields

configurationSet

ConfigurationSet configurationSet

The configuration set object associated with the specified configuration set.

deliveryOptions

DeliveryOptions deliveryOptions

Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).

eventDestinations

java.util.List<EventDestination> eventDestinations

A list of event destinations associated with the configuration set.

reputationOptions

ReputationOptions reputationOptions

An object that represents the reputation settings for the configuration set.

trackingOptions

TrackingOptions trackingOptions

The name of the custom open and click tracking domain associated with the configuration set.

Class com.amazonaws.services.simpleemail.model.DescribeReceiptRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleName

java.lang.String ruleName

The name of the receipt rule.

ruleSetName

java.lang.String ruleSetName

The name of the receipt rule set that the receipt rule belongs to.

Class com.amazonaws.services.simpleemail.model.DescribeReceiptRuleResult extends java.lang.Object implements Serializable

Serialized Fields

rule

ReceiptRule rule

A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.

Class com.amazonaws.services.simpleemail.model.DescribeReceiptRuleSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleSetName

java.lang.String ruleSetName

The name of the receipt rule set to describe.

Class com.amazonaws.services.simpleemail.model.DescribeReceiptRuleSetResult extends java.lang.Object implements Serializable

Serialized Fields

metadata

ReceiptRuleSetMetadata metadata

The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set was created.

rules

java.util.List<ReceiptRule> rules

A list of the receipt rules that belong to the specified receipt rule set.

Class com.amazonaws.services.simpleemail.model.Destination extends java.lang.Object implements Serializable

Serialized Fields

bccAddresses

java.util.List<java.lang.String> bccAddresses

The recipients to place on the BCC: line of the message.

ccAddresses

java.util.List<java.lang.String> ccAddresses

The recipients to place on the CC: line of the message.

toAddresses

java.util.List<java.lang.String> toAddresses

The recipients to place on the To: line of the message.

Class com.amazonaws.services.simpleemail.model.EventDestination extends java.lang.Object implements Serializable

Serialized Fields

cloudWatchDestination

CloudWatchDestination cloudWatchDestination

An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.

enabled

java.lang.Boolean enabled

Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false.

kinesisFirehoseDestination

KinesisFirehoseDestination kinesisFirehoseDestination

An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

matchingEventTypes

java.util.List<java.lang.String> matchingEventTypes

The type of email sending events to publish to the event destination.

name

java.lang.String name

The name of the event destination. The name must:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain less than 64 characters.

sNSDestination

SNSDestination sNSDestination

An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

Class com.amazonaws.services.simpleemail.model.EventDestinationAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

configurationSetName

java.lang.String configurationSetName

Indicates that the configuration set does not exist.

eventDestinationName

java.lang.String eventDestinationName

Indicates that the event destination does not exist.

Class com.amazonaws.services.simpleemail.model.EventDestinationDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

configurationSetName

java.lang.String configurationSetName

Indicates that the configuration set does not exist.

eventDestinationName

java.lang.String eventDestinationName

Indicates that the event destination does not exist.

Class com.amazonaws.services.simpleemail.model.ExtensionField extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

value

java.lang.String value

The value of the header to add. Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").

Class com.amazonaws.services.simpleemail.model.FromEmailAddressNotVerifiedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

fromEmailAddress

java.lang.String fromEmailAddress

Indicates that the from email address associated with the custom verification email template is not verified.

Class com.amazonaws.services.simpleemail.model.GetAccountSendingEnabledRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.simpleemail.model.GetAccountSendingEnabledResult extends java.lang.Object implements Serializable

Serialized Fields

enabled

java.lang.Boolean enabled

Describes whether email sending is enabled or disabled for your Amazon SES account in the current AWS Region.

Class com.amazonaws.services.simpleemail.model.GetCustomVerificationEmailTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

templateName

java.lang.String templateName

The name of the custom verification email template that you want to retrieve.

Class com.amazonaws.services.simpleemail.model.GetCustomVerificationEmailTemplateResult extends java.lang.Object implements Serializable

Serialized Fields

failureRedirectionURL

java.lang.String failureRedirectionURL

The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

fromEmailAddress

java.lang.String fromEmailAddress

The email address that the custom verification email is sent from.

successRedirectionURL

java.lang.String successRedirectionURL

The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

templateContent

java.lang.String templateContent

The content of the custom verification email.

templateName

java.lang.String templateName

The name of the custom verification email template.

templateSubject

java.lang.String templateSubject

The subject line of the custom verification email.

Class com.amazonaws.services.simpleemail.model.GetIdentityDkimAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identities

java.util.List<java.lang.String> identities

A list of one or more verified identities - email addresses, domains, or both.

Class com.amazonaws.services.simpleemail.model.GetIdentityDkimAttributesResult extends java.lang.Object implements Serializable

Serialized Fields

dkimAttributes

java.util.Map<java.lang.String,IdentityDkimAttributes> dkimAttributes

The DKIM attributes for an email address or a domain.

Class com.amazonaws.services.simpleemail.model.GetIdentityMailFromDomainAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identities

java.util.List<java.lang.String> identities

A list of one or more identities.

Class com.amazonaws.services.simpleemail.model.GetIdentityMailFromDomainAttributesResult extends java.lang.Object implements Serializable

Serialized Fields

mailFromDomainAttributes

java.util.Map<java.lang.String,IdentityMailFromDomainAttributes> mailFromDomainAttributes

A map of identities to custom MAIL FROM attributes.

Class com.amazonaws.services.simpleemail.model.GetIdentityNotificationAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identities

java.util.List<java.lang.String> identities

A list of one or more identities. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

Class com.amazonaws.services.simpleemail.model.GetIdentityNotificationAttributesResult extends java.lang.Object implements Serializable

Serialized Fields

notificationAttributes

java.util.Map<java.lang.String,IdentityNotificationAttributes> notificationAttributes

A map of Identity to IdentityNotificationAttributes.

Class com.amazonaws.services.simpleemail.model.GetIdentityPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identity

java.lang.String identity

The identity for which the policies will be retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

policyNames

java.util.List<java.lang.String> policyNames

A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ListIdentityPolicies.

Class com.amazonaws.services.simpleemail.model.GetIdentityPoliciesResult extends java.lang.Object implements Serializable

Serialized Fields

policies

java.util.Map<java.lang.String,java.lang.String> policies

A map of policy names to policies.

Class com.amazonaws.services.simpleemail.model.GetIdentityVerificationAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identities

java.util.List<java.lang.String> identities

A list of identities.

Class com.amazonaws.services.simpleemail.model.GetIdentityVerificationAttributesResult extends java.lang.Object implements Serializable

Serialized Fields

verificationAttributes

java.util.Map<java.lang.String,IdentityVerificationAttributes> verificationAttributes

A map of Identities to IdentityVerificationAttributes objects.

Class com.amazonaws.services.simpleemail.model.GetSendQuotaRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.simpleemail.model.GetSendQuotaResult extends java.lang.Object implements Serializable

Serialized Fields

max24HourSend

java.lang.Double max24HourSend

The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1 signifies an unlimited quota.

maxSendRate

java.lang.Double maxSendRate

The maximum number of emails that Amazon SES can accept from the user's account per second.

The rate at which Amazon SES accepts the user's messages might be less than the maximum send rate.

sentLast24Hours

java.lang.Double sentLast24Hours

The number of emails sent during the previous 24 hours.

Class com.amazonaws.services.simpleemail.model.GetSendStatisticsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.simpleemail.model.GetSendStatisticsResult extends java.lang.Object implements Serializable

Serialized Fields

sendDataPoints

java.util.List<SendDataPoint> sendDataPoints

A list of data points, each of which represents 15 minutes of activity.

Class com.amazonaws.services.simpleemail.model.GetTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

templateName

java.lang.String templateName

The name of the template you want to retrieve.

Class com.amazonaws.services.simpleemail.model.GetTemplateResult extends java.lang.Object implements Serializable

Serialized Fields

template

Template template

The content of the email, composed of a subject line, an HTML part, and a text-only part.

Class com.amazonaws.services.simpleemail.model.IdentityDkimAttributes extends java.lang.Object implements Serializable

Serialized Fields

dkimEnabled

java.lang.Boolean dkimEnabled

Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default value is true.

dkimTokens

java.util.List<java.lang.String> dkimTokens

A set of character strings that represent the domain's identity. Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)

For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.

dkimVerificationStatus

java.lang.String dkimVerificationStatus

Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)

Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure, NotStarted

Class com.amazonaws.services.simpleemail.model.IdentityMailFromDomainAttributes extends java.lang.Object implements Serializable

Serialized Fields

behaviorOnMXFailure

java.lang.String behaviorOnMXFailure

The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

Constraints:
Allowed Values: UseDefaultValue, RejectMessage

mailFromDomain

java.lang.String mailFromDomain

The custom MAIL FROM domain that the identity is configured to use.

mailFromDomainStatus

java.lang.String mailFromDomainStatus

The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure.

Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure

Class com.amazonaws.services.simpleemail.model.IdentityNotificationAttributes extends java.lang.Object implements Serializable

Serialized Fields

bounceTopic

java.lang.String bounceTopic

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.

complaintTopic

java.lang.String complaintTopic

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.

deliveryTopic

java.lang.String deliveryTopic

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.

forwardingEnabled

java.lang.Boolean forwardingEnabled

Describes whether Amazon SES will forward bounce and complaint notifications as email. true indicates that Amazon SES will forward bounce and complaint notifications as email, while false indicates that bounce and complaint notifications will be published only to the specified bounce and complaint Amazon SNS topics.

headersInBounceNotificationsEnabled

java.lang.Boolean headersInBounceNotificationsEnabled

Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Bounce. A value of true specifies that Amazon SES will include headers in bounce notifications, and a value of false specifies that Amazon SES will not include headers in bounce notifications.

headersInComplaintNotificationsEnabled

java.lang.Boolean headersInComplaintNotificationsEnabled

Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Complaint. A value of true specifies that Amazon SES will include headers in complaint notifications, and a value of false specifies that Amazon SES will not include headers in complaint notifications.

headersInDeliveryNotificationsEnabled

java.lang.Boolean headersInDeliveryNotificationsEnabled

Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Delivery. A value of true specifies that Amazon SES will include headers in delivery notifications, and a value of false specifies that Amazon SES will not include headers in delivery notifications.

Class com.amazonaws.services.simpleemail.model.IdentityVerificationAttributes extends java.lang.Object implements Serializable

Serialized Fields

verificationStatus

java.lang.String verificationStatus

The verification status of the identity: "Pending", "Success", "Failed", or "TemporaryFailure".

Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure, NotStarted

verificationToken

java.lang.String verificationToken

The verification token for a domain identity. Null for email address identities.

Class com.amazonaws.services.simpleemail.model.InvalidCloudWatchDestinationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

configurationSetName

java.lang.String configurationSetName

Indicates that the configuration set does not exist.

eventDestinationName

java.lang.String eventDestinationName

Indicates that the event destination does not exist.

Class com.amazonaws.services.simpleemail.model.InvalidConfigurationSetException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.simpleemail.model.InvalidDeliveryOptionsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.simpleemail.model.InvalidFirehoseDestinationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

configurationSetName

java.lang.String configurationSetName

Indicates that the configuration set does not exist.

eventDestinationName

java.lang.String eventDestinationName

Indicates that the event destination does not exist.

Class com.amazonaws.services.simpleemail.model.InvalidLambdaFunctionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

functionArn

java.lang.String functionArn

Indicates that the ARN of the function was not found.

Class com.amazonaws.services.simpleemail.model.InvalidPolicyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.simpleemail.model.InvalidRenderingParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

templateName

java.lang.String templateName

Class com.amazonaws.services.simpleemail.model.InvalidS3ConfigurationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

bucket

java.lang.String bucket

Indicated that the S3 Bucket was not found.

Class com.amazonaws.services.simpleemail.model.InvalidSNSDestinationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

configurationSetName

java.lang.String configurationSetName

Indicates that the configuration set does not exist.

eventDestinationName

java.lang.String eventDestinationName

Indicates that the event destination does not exist.

Class com.amazonaws.services.simpleemail.model.InvalidSnsTopicException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

topic

java.lang.String topic

Indicates that the topic does not exist.

Class com.amazonaws.services.simpleemail.model.InvalidTemplateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

templateName

java.lang.String templateName

Class com.amazonaws.services.simpleemail.model.InvalidTrackingOptionsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.simpleemail.model.KinesisFirehoseDestination extends java.lang.Object implements Serializable

Serialized Fields

deliveryStreamARN

java.lang.String deliveryStreamARN

The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.

iAMRoleARN

java.lang.String iAMRoleARN

The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.

Class com.amazonaws.services.simpleemail.model.LambdaAction extends java.lang.Object implements Serializable

Serialized Fields

functionArn

java.lang.String functionArn

The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.

invocationType

java.lang.String invocationType

The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.

There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.

Constraints:
Allowed Values: Event, RequestResponse

topicArn

java.lang.String topicArn

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Class com.amazonaws.services.simpleemail.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.simpleemail.model.ListConfigurationSetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxItems

java.lang.Integer maxItems

The number of configuration sets to return.

nextToken

java.lang.String nextToken

A token returned from a previous call to ListConfigurationSets to indicate the position of the configuration set in the configuration set list.

Class com.amazonaws.services.simpleemail.model.ListConfigurationSetsResult extends java.lang.Object implements Serializable

Serialized Fields

configurationSets

java.util.List<ConfigurationSet> configurationSets

A list of configuration sets.

nextToken

java.lang.String nextToken

A token indicating that there are additional configuration sets available to be listed. Pass this token to successive calls of ListConfigurationSets.

Class com.amazonaws.services.simpleemail.model.ListCustomVerificationEmailTemplatesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of custom verification email templates to return. This value must be at least 1 and less than or equal to 50. If you do not specify a value, or if you specify a value less than 1 or greater than 50, the operation will return up to 50 results.

Constraints:
Range: 1 - 50

nextToken

java.lang.String nextToken

An array the contains the name and creation time stamp for each template in your Amazon SES account.

Class com.amazonaws.services.simpleemail.model.ListCustomVerificationEmailTemplatesResult extends java.lang.Object implements Serializable

Serialized Fields

customVerificationEmailTemplates

java.util.List<CustomVerificationEmailTemplate> customVerificationEmailTemplates

A list of the custom verification email templates that exist in your account.

nextToken

java.lang.String nextToken

A token indicating that there are additional custom verification email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 custom verification email templates.

Class com.amazonaws.services.simpleemail.model.ListIdentitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityType

java.lang.String identityType

The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed.

Constraints:
Allowed Values: EmailAddress, Domain

maxItems

java.lang.Integer maxItems

The maximum number of identities per page. Possible values are 1-1000 inclusive.

nextToken

java.lang.String nextToken

The token to use for pagination.

Class com.amazonaws.services.simpleemail.model.ListIdentitiesResult extends java.lang.Object implements Serializable

Serialized Fields

identities

java.util.List<java.lang.String> identities

A list of identities.

nextToken

java.lang.String nextToken

The token used for pagination.

Class com.amazonaws.services.simpleemail.model.ListIdentityPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identity

java.lang.String identity

The identity that is associated with the policy for which the policies will be listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

Class com.amazonaws.services.simpleemail.model.ListIdentityPoliciesResult extends java.lang.Object implements Serializable

Serialized Fields

policyNames

java.util.List<java.lang.String> policyNames

A list of names of policies that apply to the specified identity.

Class com.amazonaws.services.simpleemail.model.ListReceiptFiltersRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.simpleemail.model.ListReceiptFiltersResult extends java.lang.Object implements Serializable

Serialized Fields

filters

java.util.List<ReceiptFilter> filters

A list of IP address filter data structures, which each consist of a name, an IP address range, and whether to allow or block mail from it.

Class com.amazonaws.services.simpleemail.model.ListReceiptRuleSetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A token returned from a previous call to ListReceiptRuleSets to indicate the position in the receipt rule set list.

Class com.amazonaws.services.simpleemail.model.ListReceiptRuleSetsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A token indicating that there are additional receipt rule sets available to be listed. Pass this token to successive calls of ListReceiptRuleSets to retrieve up to 100 receipt rule sets at a time.

ruleSets

java.util.List<ReceiptRuleSetMetadata> ruleSets

The metadata for the currently active receipt rule set. The metadata consists of the rule set name and the timestamp of when the rule set was created.

Class com.amazonaws.services.simpleemail.model.ListTemplatesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxItems

java.lang.Integer maxItems

The maximum number of templates to return. This value must be at least 1 and less than or equal to 10. If you do not specify a value, or if you specify a value less than 1 or greater than 10, the operation will return up to 10 results.

nextToken

java.lang.String nextToken

A token returned from a previous call to ListTemplates to indicate the position in the list of email templates.

Class com.amazonaws.services.simpleemail.model.ListTemplatesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 email templates.

templatesMetadata

java.util.List<TemplateMetadata> templatesMetadata

An array the contains the name and creation time stamp for each template in your Amazon SES account.

Class com.amazonaws.services.simpleemail.model.ListVerifiedEmailAddressesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.simpleemail.model.ListVerifiedEmailAddressesResult extends java.lang.Object implements Serializable

Serialized Fields

verifiedEmailAddresses

java.util.List<java.lang.String> verifiedEmailAddresses

A list of email addresses that have been verified.

Class com.amazonaws.services.simpleemail.model.MailFromDomainNotVerifiedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.simpleemail.model.Message extends java.lang.Object implements Serializable

Serialized Fields

body

Body body

The message body.

subject

Content subject

The subject of the message: A short summary of the content, which will appear in the recipient's inbox.

Class com.amazonaws.services.simpleemail.model.MessageDsn extends java.lang.Object implements Serializable

Serialized Fields

arrivalDate

java.util.Date arrivalDate

When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.

extensionFields

java.util.List<ExtensionField> extensionFields

Additional X-headers to include in the DSN.

reportingMta

java.lang.String reportingMta

The reporting MTA that attempted to deliver the message, formatted as specified in RFC 3464 ( mta-name-type; mta-name). The default value is dns; inbound-smtp.[region].amazonaws.com.

Class com.amazonaws.services.simpleemail.model.MessageRejectedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.simpleemail.model.MessageTag extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the tag. The name must:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain less than 256 characters.

value

java.lang.String value

The value of the tag. The value must:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain less than 256 characters.

Class com.amazonaws.services.simpleemail.model.MissingRenderingAttributeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

templateName

java.lang.String templateName

Class com.amazonaws.services.simpleemail.model.ProductionAccessNotGrantedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.simpleemail.model.PutConfigurationSetDeliveryOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationSetName

java.lang.String configurationSetName

The name of the configuration set that you want to specify the delivery options for.

deliveryOptions

DeliveryOptions deliveryOptions

Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).

Class com.amazonaws.services.simpleemail.model.PutConfigurationSetDeliveryOptionsResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.PutIdentityPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identity

java.lang.String identity

The identity that the policy will apply to. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

policy

java.lang.String policy

The text of the policy in JSON format. The policy cannot exceed 4 KB.

For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.

Constraints:
Length: 1 -

policyName

java.lang.String policyName

The name of the policy.

The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

Constraints:
Length: 1 - 64

Class com.amazonaws.services.simpleemail.model.PutIdentityPolicyResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.RawMessage extends java.lang.Object implements Serializable

Serialized Fields

data

java.nio.ByteBuffer data

The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding.

The To:, CC:, and BCC: headers in the raw message can contain a group list.

If you are using SendRawEmail with sending authorization, you can include X-headers in the raw message to specify the "Source," "From," and "Return-Path" addresses. For more information, see the documentation for SendRawEmail.

Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.

For more information, go to the Amazon SES Developer Guide.

Class com.amazonaws.services.simpleemail.model.ReceiptAction extends java.lang.Object implements Serializable

Serialized Fields

addHeaderAction

AddHeaderAction addHeaderAction

Adds a header to the received email.

bounceAction

BounceAction bounceAction

Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

lambdaAction

LambdaAction lambdaAction

Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.

s3Action

S3Action s3Action

Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.

sNSAction

SNSAction sNSAction

Publishes the email content within a notification to Amazon SNS.

stopAction

StopAction stopAction

Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.

workmailAction

WorkmailAction workmailAction

Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.

Class com.amazonaws.services.simpleemail.model.ReceiptFilter extends java.lang.Object implements Serializable

Serialized Fields

ipFilter

ReceiptIpFilter ipFilter

A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.

name

java.lang.String name

The name of the IP address filter. The name must:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Start and end with a letter or number.

• Contain less than 64 characters.

Class com.amazonaws.services.simpleemail.model.ReceiptIpFilter extends java.lang.Object implements Serializable

Serialized Fields

cidr

java.lang.String cidr

A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317.

policy

java.lang.String policy

Indicates whether to block or allow incoming mail from the specified IP addresses.

Constraints:
Allowed Values: Block, Allow

Class com.amazonaws.services.simpleemail.model.ReceiptRule extends java.lang.Object implements Serializable

Serialized Fields

actions

java.util.List<ReceiptAction> actions

An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

enabled

java.lang.Boolean enabled

If true, the receipt rule is active. The default value is false.

name

java.lang.String name

The name of the receipt rule. The name must:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Start and end with a letter or number.

• Contain less than 64 characters.

recipients

java.util.List<java.lang.String> recipients

The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

scanEnabled

java.lang.Boolean scanEnabled

If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

tlsPolicy

java.lang.String tlsPolicy

Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

Constraints:
Allowed Values: Require, Optional

Class com.amazonaws.services.simpleemail.model.ReceiptRuleSetMetadata extends java.lang.Object implements Serializable

Serialized Fields

createdTimestamp

java.util.Date createdTimestamp

The date and time the receipt rule set was created.

name

java.lang.String name

The name of the receipt rule set. The name must:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Start and end with a letter or number.

• Contain less than 64 characters.

Class com.amazonaws.services.simpleemail.model.RecipientDsnFields extends java.lang.Object implements Serializable

Serialized Fields

action

java.lang.String action

The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.

Constraints:
Allowed Values: failed, delayed, delivered, relayed, expanded

diagnosticCode

java.lang.String diagnosticCode

An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

extensionFields

java.util.List<ExtensionField> extensionFields

Additional X-headers to include in the DSN.

finalRecipient

java.lang.String finalRecipient

The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.

lastAttemptDate

java.util.Date lastAttemptDate

The time the final delivery attempt was made, in RFC 822 date-time format.

remoteMta

java.lang.String remoteMta

The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 ( mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.

status

java.lang.String status

The status code that indicates what went wrong. This is required by RFC 3464.

Class com.amazonaws.services.simpleemail.model.ReorderReceiptRuleSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleNames

java.util.List<java.lang.String> ruleNames

A list of the specified receipt rule set's receipt rules in the order that you want to put them.

ruleSetName

java.lang.String ruleSetName

The name of the receipt rule set to reorder.

Class com.amazonaws.services.simpleemail.model.ReorderReceiptRuleSetResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.ReputationOptions extends java.lang.Object implements Serializable

Serialized Fields

lastFreshStart

java.util.Date lastFreshStart

The date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.

When you disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled and later re-enable it, the reputation metrics for the configuration set (but not for the entire Amazon SES account) are reset.

If email sending for the configuration set has never been disabled and later re-enabled, the value of this attribute is null.

reputationMetricsEnabled

java.lang.Boolean reputationMetricsEnabled

Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.

If the value is true, reputation metrics are published. If the value is false, reputation metrics are not published. The default value is false.

sendingEnabled

java.lang.Boolean sendingEnabled

Describes whether email sending is enabled or disabled for the configuration set. If the value is true, then Amazon SES will send emails that use the configuration set. If the value is false, Amazon SES will not send emails that use the configuration set. The default value is true. You can change this setting using UpdateConfigurationSetSendingEnabled.

Class com.amazonaws.services.simpleemail.model.RuleDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

name

java.lang.String name

Indicates that the named receipt rule does not exist.

Class com.amazonaws.services.simpleemail.model.RuleSetDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

name

java.lang.String name

Indicates that the named receipt rule set does not exist.

Class com.amazonaws.services.simpleemail.model.S3Action extends java.lang.Object implements Serializable

Serialized Fields

bucketName

java.lang.String bucketName

The name of the Amazon S3 bucket that incoming email will be saved to.

kmsKeyArn

java.lang.String kmsKeyArn

The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:

• To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key.

• To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide.

For more information about key policies, see the AWS KMS Developer Guide. If you do not specify a master key, Amazon SES will not encrypt your emails.

Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.

objectKeyPrefix

java.lang.String objectKeyPrefix

The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.

topicArn

java.lang.String topicArn

The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Class com.amazonaws.services.simpleemail.model.SendBounceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bouncedRecipientInfoList

java.util.List<BouncedRecipientInfo> bouncedRecipientInfoList

A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.

bounceSender

java.lang.String bounceSender

The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.

bounceSenderArn

java.lang.String bounceSenderArn

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the "From" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.

explanation

java.lang.String explanation

Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.

messageDsn

MessageDsn messageDsn

Message-related DSN fields. If not specified, Amazon SES will choose the values.

originalMessageId

java.lang.String originalMessageId

The message ID of the message to be bounced.

Class com.amazonaws.services.simpleemail.model.SendBounceResult extends java.lang.Object implements Serializable

Serialized Fields

messageId

java.lang.String messageId

The message ID of the bounce message.

Class com.amazonaws.services.simpleemail.model.SendBulkTemplatedEmailRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationSetName

java.lang.String configurationSetName

The name of the configuration set to use when you send an email using SendBulkTemplatedEmail.

defaultTags

java.util.List<MessageTag> defaultTags

A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

defaultTemplateData

java.lang.String defaultTemplateData

A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Constraints:
Length: - 262144

destinations

java.util.List<BulkEmailDestination> destinations

One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

replyToAddresses

java.util.List<java.lang.String> replyToAddresses

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

returnPath

java.lang.String returnPath

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

returnPathArn

java.lang.String returnPathArn

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

source

java.lang.String source

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

sourceArn

java.lang.String sourceArn

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

template

java.lang.String template

The template to use when sending this email.

templateArn

java.lang.String templateArn

The ARN of the template to use when sending this email.

Class com.amazonaws.services.simpleemail.model.SendBulkTemplatedEmailResult extends java.lang.Object implements Serializable

Serialized Fields

status

java.util.List<BulkEmailDestinationStatus> status

The unique message identifier returned from the SendBulkTemplatedEmail action.

Class com.amazonaws.services.simpleemail.model.SendCustomVerificationEmailRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationSetName

java.lang.String configurationSetName

Name of a configuration set to use when sending the verification email.

emailAddress

java.lang.String emailAddress

The email address to verify.

templateName

java.lang.String templateName

The name of the custom verification email template to use when sending the verification email.

Class com.amazonaws.services.simpleemail.model.SendCustomVerificationEmailResult extends java.lang.Object implements Serializable

Serialized Fields

messageId

java.lang.String messageId

The unique message identifier returned from the SendCustomVerificationEmail operation.

Class com.amazonaws.services.simpleemail.model.SendDataPoint extends java.lang.Object implements Serializable

Serialized Fields

bounces

java.lang.Long bounces

Number of emails that have bounced.

complaints

java.lang.Long complaints

Number of unwanted emails that were rejected by recipients.

deliveryAttempts

java.lang.Long deliveryAttempts

Number of emails that have been sent.

rejects

java.lang.Long rejects

Number of emails rejected by Amazon SES.

timestamp

java.util.Date timestamp

Time of the data point.

Class com.amazonaws.services.simpleemail.model.SendEmailRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationSetName

java.lang.String configurationSetName

The name of the configuration set to use when you send an email using SendEmail.

destination

Destination destination

The destination for this email, composed of To:, CC:, and BCC: fields.

message

Message message

The message to be sent.

replyToAddresses

java.util.List<java.lang.String> replyToAddresses

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

returnPath

java.lang.String returnPath

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

returnPathArn

java.lang.String returnPathArn

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

source

java.lang.String source

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

sourceArn

java.lang.String sourceArn

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

tags

java.util.List<MessageTag> tags

A list of tags, in the form of name/value pairs, to apply to an email that you send using SendEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Class com.amazonaws.services.simpleemail.model.SendEmailResult extends java.lang.Object implements Serializable

Serialized Fields

messageId

java.lang.String messageId

The unique message identifier returned from the SendEmail action.

Class com.amazonaws.services.simpleemail.model.SendRawEmailRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationSetName

java.lang.String configurationSetName

The name of the configuration set to use when you send an email using SendRawEmail.

destinations

java.util.List<java.lang.String> destinations

A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.

fromArn

java.lang.String fromArn

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular "From" address in the header of the raw email.

Instead of using this parameter, you can use the X-header X-SES-FROM-ARN in the raw message of the email. If you use both the FromArn parameter and the corresponding X-header, Amazon SES uses the value of the FromArn parameter.

For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

rawMessage

RawMessage rawMessage

The raw email message itself. The message has to meet the following criteria:

• The message has to contain a header and a body, separated by a blank line.

• All of the required header fields must be present in the message.

• Each part of a multipart MIME message must be formatted properly.

• Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types in the Amazon SES Developer Guide.

• The entire message must be base64-encoded.

• If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email in the Amazon SES Developer Guide.

• Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.

returnPathArn

java.lang.String returnPathArn

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

Instead of using this parameter, you can use the X-header X-SES-RETURN-PATH-ARN in the raw message of the email. If you use both the ReturnPathArn parameter and the corresponding X-header, Amazon SES uses the value of the ReturnPathArn parameter.

For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

source

java.lang.String source

The identity's email address. If you do not provide a value for this parameter, you must specify a "From" address in the raw text of the message. (You can also specify both.)

Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

If you specify the Source parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.

sourceArn

java.lang.String sourceArn

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

Instead of using this parameter, you can use the X-header X-SES-SOURCE-ARN in the raw message of the email. If you use both the SourceArn parameter and the corresponding X-header, Amazon SES uses the value of the SourceArn parameter.

For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

tags

java.util.List<MessageTag> tags

A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Class com.amazonaws.services.simpleemail.model.SendRawEmailResult extends java.lang.Object implements Serializable

Serialized Fields

messageId

java.lang.String messageId

The unique message identifier returned from the SendRawEmail action.

Class com.amazonaws.services.simpleemail.model.SendTemplatedEmailRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationSetName

java.lang.String configurationSetName

The name of the configuration set to use when you send an email using SendTemplatedEmail.

destination

Destination destination

The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.

replyToAddresses

java.util.List<java.lang.String> replyToAddresses

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

returnPath

java.lang.String returnPath

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

returnPathArn

java.lang.String returnPathArn

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

source

java.lang.String source

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

sourceArn

java.lang.String sourceArn

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

tags

java.util.List<MessageTag> tags

A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

template

java.lang.String template

The template to use when sending this email.

templateArn

java.lang.String templateArn

The ARN of the template to use when sending this email.

templateData

java.lang.String templateData

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Constraints:
Length: - 262144

Class com.amazonaws.services.simpleemail.model.SendTemplatedEmailResult extends java.lang.Object implements Serializable

Serialized Fields

messageId

java.lang.String messageId

The unique message identifier returned from the SendTemplatedEmail action.

Class com.amazonaws.services.simpleemail.model.SetActiveReceiptRuleSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleSetName

java.lang.String ruleSetName

The name of the receipt rule set to make active. Setting this value to null disables all email receiving.

Class com.amazonaws.services.simpleemail.model.SetActiveReceiptRuleSetResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.SetIdentityDkimEnabledRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dkimEnabled

java.lang.Boolean dkimEnabled

Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it.

identity

java.lang.String identity

The identity for which DKIM signing should be enabled or disabled.

Class com.amazonaws.services.simpleemail.model.SetIdentityDkimEnabledResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.SetIdentityFeedbackForwardingEnabledRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

forwardingEnabled

java.lang.Boolean forwardingEnabled

Sets whether Amazon SES will forward bounce and complaint notifications as email. true specifies that Amazon SES will forward bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. false specifies that Amazon SES will publish bounce and complaint notifications only through Amazon SNS. This value can only be set to false when Amazon SNS topics are set for both Bounce and Complaint notification types.

identity

java.lang.String identity

The identity for which to set bounce and complaint notification forwarding. Examples: user@example.com, example.com.

Class com.amazonaws.services.simpleemail.model.SetIdentityFeedbackForwardingEnabledResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.SetIdentityHeadersInNotificationsEnabledRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

enabled

java.lang.Boolean enabled

Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES will include headers in notifications, and a value of false specifies that Amazon SES will not include headers in notifications.

This value can only be set when NotificationType is already set to use a particular Amazon SNS topic.

identity

java.lang.String identity

The identity for which to enable or disable headers in notifications. Examples: user@example.com, example.com.

notificationType

java.lang.String notificationType

The notification type for which to enable or disable headers in notifications.

Constraints:
Allowed Values: Bounce, Complaint, Delivery

Class com.amazonaws.services.simpleemail.model.SetIdentityHeadersInNotificationsEnabledResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.SetIdentityMailFromDomainRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

behaviorOnMXFailure

java.lang.String behaviorOnMXFailure

The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES will return a MailFromDomainNotVerified error and not send the email.

The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup is in the Pending, Failed, and TemporaryFailure states.

Constraints:
Allowed Values: UseDefaultValue, RejectMessage

identity

java.lang.String identity

The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.

mailFromDomain

java.lang.String mailFromDomain

The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a "From" address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to receive emails. A value of null disables the custom MAIL FROM setting for the identity.

Class com.amazonaws.services.simpleemail.model.SetIdentityMailFromDomainResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.SetIdentityNotificationTopicRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identity

java.lang.String identity

The identity (email address or domain) that you want to set the Amazon SNS topic for.

You can only specify a verified identity for this parameter.

You can specify an identity by using its name or by using its Amazon Resource Name (ARN). The following examples are all valid identities: sender@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

notificationType

java.lang.String notificationType

The type of notifications that will be published to the specified Amazon SNS topic.

Constraints:
Allowed Values: Bounce, Complaint, Delivery

snsTopic

java.lang.String snsTopic

The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, SnsTopic is cleared and publishing is disabled.

Class com.amazonaws.services.simpleemail.model.SetIdentityNotificationTopicResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.SetReceiptRulePositionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

after

java.lang.String after

The name of the receipt rule after which to place the specified receipt rule.

ruleName

java.lang.String ruleName

The name of the receipt rule to reposition.

ruleSetName

java.lang.String ruleSetName

The name of the receipt rule set that contains the receipt rule to reposition.

Class com.amazonaws.services.simpleemail.model.SetReceiptRulePositionResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.SNSAction extends java.lang.Object implements Serializable

Serialized Fields

encoding

java.lang.String encoding

The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.

Constraints:
Allowed Values: UTF-8, Base64

topicArn

java.lang.String topicArn

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Class com.amazonaws.services.simpleemail.model.SNSDestination extends java.lang.Object implements Serializable

Serialized Fields

topicARN

java.lang.String topicARN

The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Class com.amazonaws.services.simpleemail.model.StopAction extends java.lang.Object implements Serializable

Serialized Fields

scope

java.lang.String scope

The scope of the StopAction. The only acceptable value is RuleSet.

Constraints:
Allowed Values: RuleSet

topicArn

java.lang.String topicArn

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Class com.amazonaws.services.simpleemail.model.Template extends java.lang.Object implements Serializable

Serialized Fields

htmlPart

java.lang.String htmlPart

The HTML body of the email.

subjectPart

java.lang.String subjectPart

The subject line of the email.

templateName

java.lang.String templateName

The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.

textPart

java.lang.String textPart

The email body that will be visible to recipients whose email clients do not display HTML.

Class com.amazonaws.services.simpleemail.model.TemplateDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

templateName

java.lang.String templateName

Class com.amazonaws.services.simpleemail.model.TemplateMetadata extends java.lang.Object implements Serializable

Serialized Fields

createdTimestamp

java.util.Date createdTimestamp

The time and date the template was created.

name

java.lang.String name

The name of the template.

Class com.amazonaws.services.simpleemail.model.TestRenderTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

templateData

java.lang.String templateData

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Constraints:
Length: - 262144

templateName

java.lang.String templateName

The name of the template that you want to render.

Class com.amazonaws.services.simpleemail.model.TestRenderTemplateResult extends java.lang.Object implements Serializable

Serialized Fields

renderedTemplate

java.lang.String renderedTemplate

The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.

Class com.amazonaws.services.simpleemail.model.TrackingOptions extends java.lang.Object implements Serializable

Serialized Fields

customRedirectDomain

java.lang.String customRedirectDomain

The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain.

Class com.amazonaws.services.simpleemail.model.TrackingOptionsAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

configurationSetName

java.lang.String configurationSetName

Indicates that a TrackingOptions object already exists in the specified configuration set.

Class com.amazonaws.services.simpleemail.model.TrackingOptionsDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

configurationSetName

java.lang.String configurationSetName

Indicates that a TrackingOptions object does not exist in the specified configuration set.

Class com.amazonaws.services.simpleemail.model.UpdateAccountSendingEnabledRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

enabled

java.lang.Boolean enabled

Describes whether email sending is enabled or disabled for your Amazon SES account in the current AWS Region.

Class com.amazonaws.services.simpleemail.model.UpdateConfigurationSetEventDestinationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationSetName

java.lang.String configurationSetName

The name of the configuration set that contains the event destination that you want to update.

eventDestination

EventDestination eventDestination

The event destination object that you want to apply to the specified configuration set.

Class com.amazonaws.services.simpleemail.model.UpdateConfigurationSetEventDestinationResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.UpdateConfigurationSetReputationMetricsEnabledRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationSetName

java.lang.String configurationSetName

The name of the configuration set that you want to update.

enabled

java.lang.Boolean enabled

Describes whether or not Amazon SES will publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.

Class com.amazonaws.services.simpleemail.model.UpdateConfigurationSetSendingEnabledRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationSetName

java.lang.String configurationSetName

The name of the configuration set that you want to update.

enabled

java.lang.Boolean enabled

Describes whether email sending is enabled or disabled for the configuration set.

Class com.amazonaws.services.simpleemail.model.UpdateConfigurationSetTrackingOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationSetName

java.lang.String configurationSetName

The name of the configuration set for which you want to update the custom tracking domain.

trackingOptions

TrackingOptions trackingOptions

A domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.

For more information, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.

Class com.amazonaws.services.simpleemail.model.UpdateConfigurationSetTrackingOptionsResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.UpdateCustomVerificationEmailTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

failureRedirectionURL

java.lang.String failureRedirectionURL

The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

fromEmailAddress

java.lang.String fromEmailAddress

The email address that the custom verification email is sent from.

successRedirectionURL

java.lang.String successRedirectionURL

The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

templateContent

java.lang.String templateContent

The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.

templateName

java.lang.String templateName

The name of the custom verification email template that you want to update.

templateSubject

java.lang.String templateSubject

The subject line of the custom verification email.

Class com.amazonaws.services.simpleemail.model.UpdateReceiptRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

rule

ReceiptRule rule

A data structure that contains the updated receipt rule information.

ruleSetName

java.lang.String ruleSetName

The name of the receipt rule set that the receipt rule belongs to.

Class com.amazonaws.services.simpleemail.model.UpdateReceiptRuleResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.UpdateTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

template

Template template

The content of the email, composed of a subject line, an HTML part, and a text-only part.

Class com.amazonaws.services.simpleemail.model.UpdateTemplateResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.VerifyDomainDkimRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

java.lang.String domain

The name of the domain to be verified for Easy DKIM signing.

Class com.amazonaws.services.simpleemail.model.VerifyDomainDkimResult extends java.lang.Object implements Serializable

Serialized Fields

dkimTokens

java.util.List<java.lang.String> dkimTokens

A set of character strings that represent the domain's identity. If the identity is an email address, the tokens represent the domain of that address.

Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)

For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.

Class com.amazonaws.services.simpleemail.model.VerifyDomainIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domain

java.lang.String domain

The domain to be verified.

Class com.amazonaws.services.simpleemail.model.VerifyDomainIdentityResult extends java.lang.Object implements Serializable

Serialized Fields

verificationToken

java.lang.String verificationToken

A TXT record that you must place in the DNS settings of the domain to complete domain verification with Amazon SES.

As Amazon SES searches for the TXT record, the domain's verification status is "Pending". When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning.

Class com.amazonaws.services.simpleemail.model.VerifyEmailAddressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

emailAddress

java.lang.String emailAddress

The email address to be verified.

Class com.amazonaws.services.simpleemail.model.VerifyEmailIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

emailAddress

java.lang.String emailAddress

The email address to be verified.

Class com.amazonaws.services.simpleemail.model.VerifyEmailIdentityResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.simpleemail.model.WorkmailAction extends java.lang.Object implements Serializable

Serialized Fields

organizationArn

java.lang.String organizationArn

The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7 . For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.

topicArn

java.lang.String topicArn

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Package com.amazonaws.services.sns.model

Class com.amazonaws.services.sns.model.AddPermissionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

actionNames

java.util.List<java.lang.String> actionNames

The action you want to allow for the specified principal(s).

Valid values: Any Amazon SNS action name, for example Publish.

aWSAccountIds

java.util.List<java.lang.String> aWSAccountIds

The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service.

label

java.lang.String label

A unique identifier for the new policy statement.

topicArn

java.lang.String topicArn

The ARN of the topic whose access control policy you wish to modify.

Class com.amazonaws.services.sns.model.AuthorizationErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.BatchEntryIdsNotDistinctException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.BatchRequestTooLongException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.BatchResultErrorEntry extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.String code

An error code representing why the action failed on this entry.

id

java.lang.String id

The Id of an entry in a batch request

message

java.lang.String message

A message explaining why the action failed on this entry.

senderFault

java.lang.Boolean senderFault

Specifies whether the error happened due to the caller of the batch API action.

Class com.amazonaws.services.sns.model.CheckIfPhoneNumberIsOptedOutRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

phoneNumber

java.lang.String phoneNumber

The phone number for which you want to check the opt out status.

Class com.amazonaws.services.sns.model.CheckIfPhoneNumberIsOptedOutResult extends java.lang.Object implements Serializable

Serialized Fields

isOptedOut

java.lang.Boolean isOptedOut

Indicates whether the phone number is opted out:

• true – The phone number is opted out, meaning you cannot publish SMS messages to it.

• false – The phone number is opted in, meaning you can publish SMS messages to it.

Class com.amazonaws.services.sns.model.ConcurrentAccessException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.ConfirmSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

authenticateOnUnsubscribe

java.lang.String authenticateOnUnsubscribe

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication.

token

java.lang.String token

Short-lived token sent to an endpoint during the Subscribe action.

topicArn

java.lang.String topicArn

The ARN of the topic for which you wish to confirm a subscription.

Class com.amazonaws.services.sns.model.ConfirmSubscriptionResult extends java.lang.Object implements Serializable

Serialized Fields

subscriptionArn

java.lang.String subscriptionArn

The ARN of the created subscription.

Class com.amazonaws.services.sns.model.CreatePlatformApplicationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

For a list of attributes, see SetPlatformApplicationAttributes.

name

java.lang.String name

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

platform

java.lang.String platform

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).

Class com.amazonaws.services.sns.model.CreatePlatformApplicationResult extends java.lang.Object implements Serializable

Serialized Fields

platformApplicationArn

java.lang.String platformApplicationArn

PlatformApplicationArn is returned.

Class com.amazonaws.services.sns.model.CreatePlatformEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

For a list of attributes, see SetEndpointAttributes.

customUserData

java.lang.String customUserData

Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

platformApplicationArn

java.lang.String platformApplicationArn

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

token

java.lang.String token

Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.

Class com.amazonaws.services.sns.model.CreatePlatformEndpointResult extends java.lang.Object implements Serializable

Serialized Fields

endpointArn

java.lang.String endpointArn

EndpointArn returned from CreateEndpoint action.

Class com.amazonaws.services.sns.model.CreateSMSSandboxPhoneNumberRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language to use for sending the OTP. The default value is en-US.

Constraints:
Allowed Values: en-US, en-GB, es-419, es-ES, de-DE, fr-CA, fr-FR, it-IT, ja-JP, pt-BR, kr-KR, zh-CN, zh-TW

phoneNumber

java.lang.String phoneNumber

The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you can send SMS messages to.

Constraints:
Length: - 20
Pattern: ^(\+[0-9]{8,}|[0-9]{0,9})$

Class com.amazonaws.services.sns.model.CreateSMSSandboxPhoneNumberResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.sns.model.CreateTopicRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:

• DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

• DisplayName – The display name to use for a topic with SMS subscriptions.

• FifoTopic – Set to true to create a FIFO topic.

• Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

The following attribute applies only to server-side encryption:

• KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.

The following attributes apply only to FIFO topics:

• FifoTopic – When this is set to true, a FIFO topic is created.

• ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.

  • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.

  • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

    (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.

dataProtectionPolicy

java.lang.String dataProtectionPolicy

The body of the policy document you want to use for this topic.

You can only add one policy per topic.

The policy must be in JSON string format.

Length Constraints: Maximum length of 30,720.

name

java.lang.String name

The name of the topic you want to create.

Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.

For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.

tags

java.util.List<Tag> tags

The list of tags to add to a new topic.

To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.

Class com.amazonaws.services.sns.model.CreateTopicResult extends java.lang.Object implements Serializable

Serialized Fields

topicArn

java.lang.String topicArn

The Amazon Resource Name (ARN) assigned to the created topic.

Class com.amazonaws.services.sns.model.DeleteEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endpointArn

java.lang.String endpointArn

EndpointArn of endpoint to delete.

Class com.amazonaws.services.sns.model.DeletePlatformApplicationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

platformApplicationArn

java.lang.String platformApplicationArn

PlatformApplicationArn of platform application object to delete.

Class com.amazonaws.services.sns.model.DeleteSMSSandboxPhoneNumberRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

phoneNumber

java.lang.String phoneNumber

The destination phone number to delete.

Constraints:
Length: - 20
Pattern: ^(\+[0-9]{8,}|[0-9]{0,9})$

Class com.amazonaws.services.sns.model.DeleteSMSSandboxPhoneNumberResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.sns.model.DeleteTopicRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

topicArn

java.lang.String topicArn

The ARN of the topic you want to delete.

Class com.amazonaws.services.sns.model.EmptyBatchRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.Endpoint extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

Attributes for endpoint.

endpointArn

java.lang.String endpointArn

The EndpointArn for mobile app and device.

Class com.amazonaws.services.sns.model.EndpointDisabledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.FilterPolicyLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.GetDataProtectionPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The ARN of the topic whose DataProtectionPolicy you want to get.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Class com.amazonaws.services.sns.model.GetDataProtectionPolicyResult extends java.lang.Object implements Serializable

Serialized Fields

dataProtectionPolicy

java.lang.String dataProtectionPolicy

Retrieves the DataProtectionPolicy in JSON string format.

Class com.amazonaws.services.sns.model.GetEndpointAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endpointArn

java.lang.String endpointArn

EndpointArn for GetEndpointAttributes input.

Class com.amazonaws.services.sns.model.GetEndpointAttributesResult extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

Attributes include the following:

• CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

• Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

• Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

  The device token for the iOS platform is returned in lowercase.

Class com.amazonaws.services.sns.model.GetPlatformApplicationAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

platformApplicationArn

java.lang.String platformApplicationArn

PlatformApplicationArn for GetPlatformApplicationAttributesInput.

Class com.amazonaws.services.sns.model.GetPlatformApplicationAttributesResult extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

Attributes include the following:

• AppleCertificateExpiryDate – The expiry date of the SSL certificate used to configure certificate-based authentication.

• ApplePlatformTeamID – The Apple developer account ID used to configure token-based authentication.

• ApplePlatformBundleID – The app identifier used to configure token-based authentication.

• EventEndpointCreated – Topic ARN to which EndpointCreated event notifications should be sent.

• EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications should be sent.

• EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications should be sent.

• EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

Class com.amazonaws.services.sns.model.GetSMSAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

java.util.List<java.lang.String> attributes

A list of the individual attribute names, such as MonthlySpendLimit, for which you want values.

For all attribute names, see SetSMSAttributes.

If you don't use this parameter, Amazon SNS returns all SMS attributes.

Class com.amazonaws.services.sns.model.GetSMSAttributesResult extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

The SMS attribute names and their values.

Class com.amazonaws.services.sns.model.GetSMSSandboxAccountStatusRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.sns.model.GetSMSSandboxAccountStatusResult extends java.lang.Object implements Serializable

Serialized Fields

isInSandbox

java.lang.Boolean isInSandbox

Indicates whether the calling Amazon Web Services account is in the SMS sandbox.

Class com.amazonaws.services.sns.model.GetSubscriptionAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subscriptionArn

java.lang.String subscriptionArn

The ARN of the subscription whose properties you want to get.

Class com.amazonaws.services.sns.model.GetSubscriptionAttributesResult extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

A map of the subscription's attributes. Attributes in this map include the following:

• ConfirmationWasAuthenticated – true if the subscription confirmation request was authenticated.

• DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

• EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

• FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

• Owner – The Amazon Web Services account ID of the subscription's owner.

• PendingConfirmation – true if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

• RawMessageDelivery – true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

• RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

• SubscriptionArn – The subscription's ARN.

• TopicArn – The topic ARN that the subscription is associated with.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

• SubscriptionRoleArn – The ARN of the IAM role that has the following:

  • Permission to write to the Kinesis Data Firehose delivery stream

  • Amazon SNS listed as a trusted entity

  Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

Class com.amazonaws.services.sns.model.GetTopicAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

topicArn

java.lang.String topicArn

The ARN of the topic whose properties you want to get.

Class com.amazonaws.services.sns.model.GetTopicAttributesResult extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

A map of the topic's attributes. Attributes in this map include the following:

• DeliveryPolicy – The JSON serialization of the topic's delivery policy.

• DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints.

• Owner – The Amazon Web Services account ID of the topic's owner.

• Policy – The JSON serialization of the topic's access control policy.

• SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.

• SubscriptionsDeleted – The number of deleted subscriptions for the topic.

• SubscriptionsPending – The number of subscriptions pending confirmation for the topic.

• TopicArn – The topic's ARN.

• EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account.

The following attribute applies only to server-side-encryption:

• KmsMasterKeyId - The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.

The following attributes apply only to FIFO topics:

• FifoTopic – When this is set to true, a FIFO topic is created.

• ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.

  • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.

  • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

    (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.

Class com.amazonaws.services.sns.model.InternalErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.InvalidBatchEntryIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.InvalidSecurityException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.KMSAccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.KMSDisabledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.KMSInvalidStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.KMSNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.KMSOptInRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.KMSThrottlingException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.ListEndpointsByPlatformApplicationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.

platformApplicationArn

java.lang.String platformApplicationArn

PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

Class com.amazonaws.services.sns.model.ListEndpointsByPlatformApplicationResult extends java.lang.Object implements Serializable

Serialized Fields

endpoints

java.util.List<Endpoint> endpoints

Endpoints returned for ListEndpointsByPlatformApplication action.

nextToken

java.lang.String nextToken

NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.

Class com.amazonaws.services.sns.model.ListOriginationNumbersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of origination numbers to return.

Constraints:
Range: 1 - 30

nextToken

java.lang.String nextToken

Token that the previous ListOriginationNumbers request returns.

Class com.amazonaws.services.sns.model.ListOriginationNumbersResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A NextToken string is returned when you call the ListOriginationNumbers operation if additional pages of records are available.

phoneNumbers

java.util.List<PhoneNumberInformation> phoneNumbers

A list of the calling account's verified and pending origination numbers.

Class com.amazonaws.services.sns.model.ListPhoneNumbersOptedOutRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.

Class com.amazonaws.services.sns.model.ListPhoneNumbersOptedOutResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results.

phoneNumbers

java.util.List<java.lang.String> phoneNumbers

A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.

Class com.amazonaws.services.sns.model.ListPlatformApplicationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.

Class com.amazonaws.services.sns.model.ListPlatformApplicationsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.

platformApplications

java.util.List<PlatformApplication> platformApplications

Platform applications returned when calling ListPlatformApplications action.

Class com.amazonaws.services.sns.model.ListSMSSandboxPhoneNumbersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of phone numbers to return.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

Token that the previous ListSMSSandboxPhoneNumbersInput request returns.

Class com.amazonaws.services.sns.model.ListSMSSandboxPhoneNumbersResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

A NextToken string is returned when you call the ListSMSSandboxPhoneNumbersInput operation if additional pages of records are available.

phoneNumbers

java.util.List<SMSSandboxPhoneNumber> phoneNumbers

A list of the calling account's pending and verified phone numbers.

Class com.amazonaws.services.sns.model.ListSubscriptionsByTopicRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

Token returned by the previous ListSubscriptionsByTopic request.

topicArn

java.lang.String topicArn

The ARN of the topic for which you wish to find subscriptions.

Class com.amazonaws.services.sns.model.ListSubscriptionsByTopicResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.

subscriptions

java.util.List<Subscription> subscriptions

A list of subscriptions.

Class com.amazonaws.services.sns.model.ListSubscriptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

Token returned by the previous ListSubscriptions request.

Class com.amazonaws.services.sns.model.ListSubscriptionsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.

subscriptions

java.util.List<Subscription> subscriptions

A list of subscriptions.

Class com.amazonaws.services.sns.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The ARN of the topic for which to list tags.

Constraints:
Length: 1 - 1011

Class com.amazonaws.services.sns.model.ListTagsForResourceResult extends java.lang.Object implements Serializable

Serialized Fields

tags

java.util.List<Tag> tags

The tags associated with the specified topic.

Class com.amazonaws.services.sns.model.ListTopicsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

Token returned by the previous ListTopics request.

Class com.amazonaws.services.sns.model.ListTopicsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.

topics

java.util.List<Topic> topics

A list of topic ARNs.

Class com.amazonaws.services.sns.model.MessageAttributeValue extends java.lang.Object implements Serializable

Serialized Fields

binaryValue

java.nio.ByteBuffer binaryValue

Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

dataType

java.lang.String dataType

Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types.

stringValue

java.lang.String stringValue

Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.

Class com.amazonaws.services.sns.model.NotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.OptedOutException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.OptInPhoneNumberRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

phoneNumber

java.lang.String phoneNumber

The phone number to opt in. Use E.164 format.

Class com.amazonaws.services.sns.model.OptInPhoneNumberResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.sns.model.PhoneNumberInformation extends java.lang.Object implements Serializable

Serialized Fields

createdAt

java.util.Date createdAt

The date and time when the phone number was created.

iso2CountryCode

java.lang.String iso2CountryCode

The two-character code for the country or region, in ISO 3166-1 alpha-2 format.

Constraints:
Length: - 2
Pattern: ^[A-Za-z]{2}$

numberCapabilities

java.util.List<java.lang.String> numberCapabilities

The capabilities of each phone number.

phoneNumber

java.lang.String phoneNumber

The phone number.

routeType

java.lang.String routeType

The list of supported routes.

Constraints:
Allowed Values: Transactional, Promotional, Premium

status

java.lang.String status

The status of the phone number.

Class com.amazonaws.services.sns.model.PlatformApplication extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

Attributes for platform application object.

platformApplicationArn

java.lang.String platformApplicationArn

PlatformApplicationArn for platform application object.

Class com.amazonaws.services.sns.model.PlatformApplicationDisabledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.PublishBatchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

publishBatchRequestEntries

java.util.List<PublishBatchRequestEntry> publishBatchRequestEntries

A list of PublishBatch request entries to be sent to the SNS topic.

topicArn

java.lang.String topicArn

The Amazon resource name (ARN) of the topic you want to batch publish to.

Class com.amazonaws.services.sns.model.PublishBatchRequestEntry extends java.lang.Object implements Serializable

Serialized Fields

id

java.lang.String id

An identifier for the message in this batch.

The Ids of a batch request must be unique within a request.

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

message

java.lang.String message

The body of the message.

messageAttributes

java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes

Each message attribute consists of a Name, Type , and Value. For more information, see Amazon SNS message attributes in the Amazon SNS Developer Guide.

messageDeduplicationId

java.lang.String messageDeduplicationId

This parameter applies only to FIFO (first-in-first-out) topics.

The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered.

• Every message must have a unique MessageDeduplicationId.

  • You may provide a MessageDeduplicationId explicitly.

  • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your topic, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

  • If you don't provide a MessageDeduplicationId and the topic doesn't have ContentBasedDeduplication set, the action fails with an error.

  • If the topic has a ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

• When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

• If you send one message with ContentBasedDeduplication enabled, and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).

If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SNS can't detect duplicate messages.

Amazon SNS continues to keep track of the message deduplication ID even after the message is received and deleted.

The length of MessageDeduplicationId is 128 characters.

MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

messageGroupId

java.lang.String messageGroupId

This parameter applies only to FIFO (first-in-first-out) topics.

The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single topic, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the topic, but the session data of each user is processed in a FIFO fashion.

You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.

The length of MessageGroupId is 128 characters.

MessageGroupId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

MessageGroupId is required for FIFO topics. You can't use it for standard topics.

messageStructure

java.lang.String messageStructure

Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:

• be a syntactically valid JSON object; and

• contain at least a top-level JSON key of "default" with a value that is a string.

You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g. http).

subject

java.lang.String subject

The subject of the batch message.

Class com.amazonaws.services.sns.model.PublishBatchResult extends java.lang.Object implements Serializable

Serialized Fields

failed

java.util.List<BatchResultErrorEntry> failed

A list of failed PublishBatch responses.

successful

java.util.List<PublishBatchResultEntry> successful

A list of successful PublishBatch responses.

Class com.amazonaws.services.sns.model.PublishBatchResultEntry extends java.lang.Object implements Serializable

Serialized Fields

id

java.lang.String id

The Id of an entry in a batch request.

messageId

java.lang.String messageId

An identifier for the message.

sequenceNumber

java.lang.String sequenceNumber

This parameter applies only to FIFO (first-in-first-out) topics.

The large, non-consecutive number that Amazon SNS assigns to each message.

The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.

Class com.amazonaws.services.sns.model.PublishRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

message

java.lang.String message

The message you want to send.

If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

Constraints:

• With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).

• For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.

  If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.

  The total size limit for a single SMS Publish action is 1,600 characters.

JSON-specific constraints:

• Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.

• The values will be parsed (unescaped) before they are used in outgoing messages.

• Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).

• Values have a minimum length of 0 (the empty string, "", is allowed).

• Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).

• Non-string values will cause the key to be ignored.

• Keys that do not correspond to supported transport protocols are ignored.

• Duplicate keys are not allowed.

• Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).

messageAttributes

java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes

Message attributes for Publish action.

messageDeduplicationId

java.lang.String messageDeduplicationId

This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is treated as a duplicate.

If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId overrides the generated one.

messageGroupId

java.lang.String messageGroupId

This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

The MessageGroupId is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a MessageGroupId.

messageStructure

java.lang.String messageStructure

Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:

• be a syntactically valid JSON object; and

• contain at least a top-level JSON key of "default" with a value that is a string.

You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").

Valid value: json

phoneNumber

java.lang.String phoneNumber

The phone number to which you want to deliver an SMS message. Use E.164 format.

If you don't specify a value for the PhoneNumber parameter, you must specify a value for the TargetArn or TopicArn parameters.

subject

java.lang.String subject

Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

targetArn

java.lang.String targetArn

If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.

topicArn

java.lang.String topicArn

The topic you want to publish to.

If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.

Class com.amazonaws.services.sns.model.PublishResult extends java.lang.Object implements Serializable

Serialized Fields

messageId

java.lang.String messageId

Unique identifier assigned to the published message.

Length Constraint: Maximum 100 characters

sequenceNumber

java.lang.String sequenceNumber

This response element applies only to FIFO (first-in-first-out) topics.

The sequence number is a large, non-consecutive number that Amazon SNS assigns to each message. The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for each MessageGroupId.

Class com.amazonaws.services.sns.model.PutDataProtectionPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dataProtectionPolicy

java.lang.String dataProtectionPolicy

The JSON serialization of the topic's DataProtectionPolicy.

The DataProtectionPolicy must be in JSON string format.

Length Constraints: Maximum length of 30,720.

resourceArn

java.lang.String resourceArn

The ARN of the topic whose DataProtectionPolicy you want to add or update.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Class com.amazonaws.services.sns.model.RemovePermissionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

label

java.lang.String label

The unique label of the statement you want to remove.

topicArn

java.lang.String topicArn

The ARN of the topic whose access control policy you wish to modify.

Class com.amazonaws.services.sns.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.SetEndpointAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

A map of the endpoint attributes. Attributes in this map include the following:

• CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

• Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

• Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

endpointArn

java.lang.String endpointArn

EndpointArn used for SetEndpointAttributes action.

Class com.amazonaws.services.sns.model.SetPlatformApplicationAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

A map of the platform application attributes. Attributes in this map include the following:

• PlatformCredential – The credential received from the notification service.

  • For ADM, PlatformCredentialis client secret.

  • For Apple Services using certificate credentials, PlatformCredential is private key.

  • For Apple Services using token credentials, PlatformCredential is signing key.

  • For GCM (Firebase Cloud Messaging), PlatformCredential is API key.

• PlatformPrincipal – The principal received from the notification service.

  • For ADM, PlatformPrincipalis client id.

  • For Apple Services using certificate credentials, PlatformPrincipal is SSL certificate.

  • For Apple Services using token credentials, PlatformPrincipal is signing key ID.

  • For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal.

• EventEndpointCreated – Topic ARN to which EndpointCreated event notifications are sent.

• EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications are sent.

• EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications are sent.

• EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

• SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

• FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

• SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.

The following attributes only apply to APNs token-based authentication:

• ApplePlatformTeamID – The identifier that's assigned to your Apple developer account team.

• ApplePlatformBundleID – The bundle identifier that's assigned to your iOS app.

platformApplicationArn

java.lang.String platformApplicationArn

PlatformApplicationArn for SetPlatformApplicationAttributes action.

Class com.amazonaws.services.sns.model.SetSMSAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

The default settings for sending SMS messages from your Amazon Web Services account. You can set values for the following attribute names:

MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.

Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.

By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For New limit value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase.

DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.

DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.

DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.

DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:

• Promotional – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.

• Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.

UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your Amazon Web Services account:

• Time that the message was published (in UTC)

• Message ID

• Destination phone number

• Message type

• Delivery status

• Message price (in USD)

• Part number (a message is split into multiple parts if it is too long for a single message)

• Total number of parts

To receive the report, the bucket must have a policy that allows the Amazon SNS service principal to perform the s3:PutObject and s3:GetBucketLocation actions.

For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide.

Class com.amazonaws.services.sns.model.SetSMSAttributesResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.sns.model.SetSubscriptionAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeName

java.lang.String attributeName

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that this action uses:

• DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

• FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

• RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

• RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

• SubscriptionRoleArn – The ARN of the IAM role that has the following:

  • Permission to write to the Kinesis Data Firehose delivery stream

  • Amazon SNS listed as a trusted entity

  Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

attributeValue

java.lang.String attributeValue

The new value for the attribute in JSON format.

subscriptionArn

java.lang.String subscriptionArn

The ARN of the subscription to modify.

Class com.amazonaws.services.sns.model.SetTopicAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeName

java.lang.String attributeName

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

• DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

• DisplayName – The display name to use for a topic with SMS subscriptions.

• Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

The following attribute applies only to server-side-encryption:

• KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.

The following attribute applies only to FIFO topics:

• ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.

  • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.

  • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

    (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.

attributeValue

java.lang.String attributeValue

The new value for the attribute.

topicArn

java.lang.String topicArn

The ARN of the topic to modify.

Class com.amazonaws.services.sns.model.SMSSandboxPhoneNumber extends java.lang.Object implements Serializable

Serialized Fields

phoneNumber

java.lang.String phoneNumber

The destination phone number.

Constraints:
Length: - 20
Pattern: ^(\+[0-9]{8,}|[0-9]{0,9})$

status

java.lang.String status

The destination phone number's verification status.

Constraints:
Allowed Values: Pending, Verified

Class com.amazonaws.services.sns.model.StaleTagException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.SubscribeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the Subscribe action uses:

• DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

• FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

• RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

• RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

• SubscriptionRoleArn – The ARN of the IAM role that has the following:

  • Permission to write to the Kinesis Data Firehose delivery stream

  • Amazon SNS listed as a trusted entity

  Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

endpoint

java.lang.String endpoint

The endpoint that you want to receive notifications. Endpoints vary by protocol:

• For the http protocol, the (public) endpoint is a URL beginning with http://.

• For the https protocol, the (public) endpoint is a URL beginning with https://.

• For the email protocol, the endpoint is an email address.

• For the email-json protocol, the endpoint is an email address.

• For the sms protocol, the endpoint is a phone number of an SMS-enabled device.

• For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.

• For the application protocol, the endpoint is the EndpointArn of a mobile app and device.

• For the lambda protocol, the endpoint is the ARN of an Lambda function.

• For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

protocol

java.lang.String protocol

The protocol that you want to use. Supported protocols include:

• http – delivery of JSON-encoded message via HTTP POST

• https – delivery of JSON-encoded message via HTTPS POST

• email – delivery of message via SMTP

• email-json – delivery of JSON-encoded message via SMTP

• sms – delivery of message via SMS

• sqs – delivery of JSON-encoded message to an Amazon SQS queue

• application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device

• lambda – delivery of JSON-encoded message to an Lambda function

• firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

returnSubscriptionArn

java.lang.Boolean returnSubscriptionArn

Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.

If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes the pending subscription ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.

The default value is false.

topicArn

java.lang.String topicArn

The ARN of the topic you want to subscribe to.

Class com.amazonaws.services.sns.model.SubscribeResult extends java.lang.Object implements Serializable

Serialized Fields

subscriptionArn

java.lang.String subscriptionArn

The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription requires confirmation. However, if the API request parameter ReturnSubscriptionArn is true, then the value is always the subscription ARN, even if the subscription requires confirmation.

Class com.amazonaws.services.sns.model.Subscription extends java.lang.Object implements Serializable

Serialized Fields

endpoint

java.lang.String endpoint

The subscription's endpoint (format depends on the protocol).

owner

java.lang.String owner

The subscription's owner.

protocol

java.lang.String protocol

The subscription's protocol.

subscriptionArn

java.lang.String subscriptionArn

The subscription's ARN.

topicArn

java.lang.String topicArn

The ARN of the subscription's topic.

Class com.amazonaws.services.sns.model.SubscriptionLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.Tag extends java.lang.Object implements Serializable

Serialized Fields

key

java.lang.String key

The required key portion of the tag.

Constraints:
Length: 1 - 128

value

java.lang.String value

The optional value portion of the tag.

Constraints:
Length: 0 - 256

Class com.amazonaws.services.sns.model.TagLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.TagPolicyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The ARN of the topic to which to add tags.

Constraints:
Length: 1 - 1011

tags

java.util.List<Tag> tags

The tags to be added to the specified topic. A tag consists of a required key and an optional value.

Class com.amazonaws.services.sns.model.TagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.sns.model.ThrottledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.TooManyEntriesInBatchRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.Topic extends java.lang.Object implements Serializable

Serialized Fields

topicArn

java.lang.String topicArn

The topic's ARN.

Class com.amazonaws.services.sns.model.TopicLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.UnsubscribeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subscriptionArn

java.lang.String subscriptionArn

The ARN of the subscription to be deleted.

Class com.amazonaws.services.sns.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The ARN of the topic from which to remove tags.

Constraints:
Length: 1 - 1011

tagKeys

java.util.List<java.lang.String> tagKeys

The list of tag keys to remove from the specified topic.

Class com.amazonaws.services.sns.model.UntagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.sns.model.UserErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.ValidationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sns.model.VerificationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

status

java.lang.String status

The status of the verification error.

Class com.amazonaws.services.sns.model.VerifySMSSandboxPhoneNumberRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

oneTimePassword

java.lang.String oneTimePassword

The OTP sent to the destination number from the CreateSMSSandBoxPhoneNumber call.

Constraints:
Length: 5 - 8
Pattern: ^[0-9]+$

phoneNumber

java.lang.String phoneNumber

The destination phone number to verify.

Constraints:
Length: - 20
Pattern: ^(\+[0-9]{8,}|[0-9]{0,9})$

Class com.amazonaws.services.sns.model.VerifySMSSandboxPhoneNumberResult extends java.lang.Object implements Serializable

Package com.amazonaws.services.sqs.model

Class com.amazonaws.services.sqs.model.AddPermissionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

actions

java.util.List<java.lang.String> actions

The action the client wants to allow for the specified principal. The following are valid values: * | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl . For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for the ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

aWSAccountIds

java.util.List<java.lang.String> aWSAccountIds

The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon SQS Developer Guide.

label

java.lang.String label

The unique identification of the permission you're setting (e.g., AliceSendMessage). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.

queueUrl

java.lang.String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Class com.amazonaws.services.sqs.model.BatchEntryIdsNotDistinctException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.BatchRequestTooLongException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.BatchResultErrorEntry extends java.lang.Object implements Serializable

Serialized Fields

code

java.lang.String code

An error code representing why the action failed on this entry.

id

java.lang.String id

The id of an entry in a batch request.

message

java.lang.String message

A message explaining why the action failed on this entry.

senderFault

java.lang.Boolean senderFault

Whether the error happened due to the sender's fault.

Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

entries

java.util.List<ChangeMessageVisibilityBatchRequestEntry> entries

A list of receipt handles of the messages for which the visibility timeout must be changed.

queueUrl

java.lang.String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchRequestEntry extends java.lang.Object implements Serializable

Serialized Fields

id

java.lang.String id

An identifier for this particular receipt handle. This is used to communicate the result. Note that the Ids of a batch request need to be unique within the request.

receiptHandle

java.lang.String receiptHandle

A receipt handle.

visibilityTimeout

java.lang.Integer visibilityTimeout

The new value (in seconds) for the message's visibility timeout.

Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchResult extends java.lang.Object implements Serializable

Serialized Fields

failed

java.util.List<BatchResultErrorEntry> failed

A list of BatchResultErrorEntry items.

successful

java.util.List<ChangeMessageVisibilityBatchResultEntry> successful

A list of ChangeMessageVisibilityBatchResultEntry items.

Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchResultEntry extends java.lang.Object implements Serializable

Serialized Fields

id

java.lang.String id

Represents a message whose visibility timeout has been changed successfully.

Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

java.lang.String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

receiptHandle

java.lang.String receiptHandle

The receipt handle associated with the message whose visibility timeout should be changed. This parameter is returned by the ReceiveMessage action.

visibilityTimeout

java.lang.Integer visibilityTimeout

The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout.

Class com.amazonaws.services.sqs.model.CreateQueueRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:

• DelaySeconds - The number of seconds for which the delivery of all messages in the queue is delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero).

• MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB).

• MessageRetentionPeriod - The number of seconds for which Amazon SQS retains a message. An integer representing seconds, from 60 (1 minute) to 120,9600 (14 days). The default is 345,600 (4 days).

• Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.

• ReceiveMessageWaitTimeSeconds - The number of seconds for which a ReceiveMessage action will wait for a message to arrive. An integer from 0 to 20 (seconds). The default is 0.

• RedrivePolicy - The parameters for the dead letter queue functionality of the source queue. For more information about the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

  The dead letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead letter queue of a standard queue must also be a standard queue.

• VisibilityTimeout - The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to FIFO (first-in-first-out) queues:

• FifoQueue - Designates a queue as FIFO. You can provide this attribute only during queue creation; you can't change it for an existing queue. When you set this attribute, you must provide a MessageGroupId explicitly.

  For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.

• ContentBasedDeduplication - Enables content-based deduplication. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

  • Every message must have a unique MessageDeduplicationId,

    • You may provide a MessageDeduplicationId explicitly.

    • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

    • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.

    • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

  • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

  • You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates.

  • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages, ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, and QueueArn) will be ignored.

queueName

java.lang.String queueName

The name of the new queue. The following limits apply to this name:

• A queue name can have up to 80 characters.

• The following are accepted: alphanumeric chatacters, hyphens ( -), and underscores (_).

• A FIFO queue name must end with the .fifo suffix.

Queue names are case-sensitive.

Class com.amazonaws.services.sqs.model.CreateQueueResult extends java.lang.Object implements Serializable

Serialized Fields

queueUrl

java.lang.String queueUrl

The URL for the created Amazon SQS queue.

Class com.amazonaws.services.sqs.model.DeleteMessageBatchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

entries

java.util.List<DeleteMessageBatchRequestEntry> entries

A list of receipt handles for the messages to be deleted.

queueUrl

java.lang.String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Class com.amazonaws.services.sqs.model.DeleteMessageBatchRequestEntry extends java.lang.Object implements Serializable

Serialized Fields

id

java.lang.String id

An identifier for this particular receipt handle. This is used to communicate the result. Note that the Ids of a batch request need to be unique within the request.

receiptHandle

java.lang.String receiptHandle

A receipt handle.

Class com.amazonaws.services.sqs.model.DeleteMessageBatchResult extends java.lang.Object implements Serializable

Serialized Fields

failed

java.util.List<BatchResultErrorEntry> failed

A list of BatchResultErrorEntry items.

successful

java.util.List<DeleteMessageBatchResultEntry> successful

A list of DeleteMessageBatchResultEntry items.

Class com.amazonaws.services.sqs.model.DeleteMessageBatchResultEntry extends java.lang.Object implements Serializable

Serialized Fields

id

java.lang.String id

Represents a successfully deleted message.

Class com.amazonaws.services.sqs.model.DeleteMessageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

java.lang.String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

receiptHandle

java.lang.String receiptHandle

The receipt handle associated with the message to delete.

Class com.amazonaws.services.sqs.model.DeleteQueueRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

java.lang.String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Class com.amazonaws.services.sqs.model.EmptyBatchRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.GetQueueAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeNames

java.util.List<java.lang.String> attributeNames

A list of attributes for which to retrieve information.

Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

The following attributes are supported:

• All - Returns all values.

• ApproximateNumberOfMessages - Returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

• ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages that are waiting to be added to the queue.

• ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that have not timed-out and are not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

• CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).

• DelaySeconds - Returns the default delay on the queue in seconds.

• LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).

• MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

• MessageRetentionPeriod - Returns the number of seconds for which Amazon SQS retains a message.

• Policy - Returns the policy of the queue.

• QueueArn - Returns the Amazon resource name (ARN) of the queue.

• ReceiveMessageWaitTimeSeconds - Returns the number of seconds for which ReceiveMessage call will wait for a message to arrive.

• RedrivePolicy - Returns the parameters for dead letter queue functionality of the source queue. For more information about the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

• VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to FIFO (first-in-first-out) queues:

• FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.

• ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

queueUrl

java.lang.String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Class com.amazonaws.services.sqs.model.GetQueueAttributesResult extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

A map of attributes to the respective values.

Class com.amazonaws.services.sqs.model.GetQueueUrlRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueName

java.lang.String queueName

The name of the queue whose URL must be fetched. Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.

Queue names are case-sensitive.

queueOwnerAWSAccountId

java.lang.String queueOwnerAWSAccountId

The AWS account ID of the account that created the queue.

Class com.amazonaws.services.sqs.model.GetQueueUrlResult extends java.lang.Object implements Serializable

Serialized Fields

queueUrl

java.lang.String queueUrl

The URL for the queue.

Class com.amazonaws.services.sqs.model.InvalidAttributeNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.InvalidBatchEntryIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.InvalidIdFormatException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.InvalidMessageContentsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.ListDeadLetterSourceQueuesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

java.lang.String queueUrl

The queue URL of a dead letter queue.

Queue URLs are case-sensitive.

Class com.amazonaws.services.sqs.model.ListDeadLetterSourceQueuesResult extends java.lang.Object implements Serializable

Serialized Fields

queueUrls

java.util.List<java.lang.String> queueUrls

A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead letter queue.

Class com.amazonaws.services.sqs.model.ListQueuesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueNamePrefix

java.lang.String queueNamePrefix

A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Queue names are case-sensitive.

Class com.amazonaws.services.sqs.model.ListQueuesResult extends java.lang.Object implements Serializable

Serialized Fields

queueUrls

java.util.List<java.lang.String> queueUrls

A list of queue URLs, up to 1000 entries.

Class com.amazonaws.services.sqs.model.Message extends java.lang.Object implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

SenderId, SentTimestamp, ApproximateReceiveCount, and/or ApproximateFirstReceiveTimestamp. SentTimestamp and ApproximateFirstReceiveTimestamp are each returned as an integer representing the epoch time in milliseconds.

body

java.lang.String body

The message's contents (not URL-encoded).

mD5OfBody

java.lang.String mD5OfBody

An MD5 digest of the non-URL-encoded message body string.

mD5OfMessageAttributes

java.lang.String mD5OfMessageAttributes

An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

messageAttributes

java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes

Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide.

messageId

java.lang.String messageId

A unique identifier for the message. Message IDs are considered unique across all AWS accounts for an extended period of time.

receiptHandle

java.lang.String receiptHandle

An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.

Class com.amazonaws.services.sqs.model.MessageAttributeValue extends java.lang.Object implements Serializable

Serialized Fields

binaryListValues

java.util.List<java.nio.ByteBuffer> binaryListValues

Not implemented. Reserved for future use.

binaryValue

java.nio.ByteBuffer binaryValue

Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

dataType

java.lang.String dataType

Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

You can also append custom labels. For more information, see Message Attribute Data Types in the Amazon SQS Developer Guide.

stringListValues

java.util.List<java.lang.String> stringListValues

Not implemented. Reserved for future use.

stringValue

java.lang.String stringValue

Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.

Class com.amazonaws.services.sqs.model.MessageNotInflightException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.OverLimitException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.PurgeQueueInProgressException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.PurgeQueueRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

java.lang.String queueUrl

The queue URL of the queue to delete the messages from when using the PurgeQueue API.

Queue URLs are case-sensitive.

Class com.amazonaws.services.sqs.model.QueueDeletedRecentlyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.QueueDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.QueueNameExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.ReceiptHandleIsInvalidException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.ReceiveMessageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeNames

java.util.List<java.lang.String> attributeNames

A list of attributes that need to be returned along with each message. These attributes include:

• All - Returns all values.

• ApproximateFirstReceiveTimestamp - Returns the time the message was first received from the queue (epoch time in milliseconds).

• ApproximateReceiveCount - Returns the number of times a message has been received from the queue but not deleted.

• SenderId

  • For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.

  • For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

• SentTimestamp - Returns the time the message was sent to the queue (epoch time in milliseconds).

• MessageDeduplicationId - Returns the value provided by the sender that calls the SendMessage action.

• MessageGroupId - Returns the value provided by the sender that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.

• SequenceNumber - Returns the value provided by Amazon SQS.

Any other valid special request parameters (such as the following) that are specified are ignored:

• ApproximateNumberOfMessages

• ApproximateNumberOfMessagesDelayed

• ApproximateNumberOfMessagesNotVisible

• CreatedTimestamp

• ContentBasedDeduplication

• DelaySeconds

• LastModifiedTimestamp

• MaximumMessageSize

• MessageRetentionPeriod

• Policy

• QueueArn,

• ReceiveMessageWaitTimeSeconds

• RedrivePolicy

• FifoQueue

• VisibilityTimeout

maxNumberOfMessages

java.lang.Integer maxNumberOfMessages

The maximum number of messages to return. Amazon SQS never returns more messages than this value but might return fewer. Values can be from 1 to 10. Default is 1.

All of the messages are not necessarily returned.

messageAttributeNames

java.util.List<java.lang.String> messageAttributeNames

The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name can't start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "bar.*" to return all message attributes starting with the "bar" prefix.

queueUrl

java.lang.String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

receiveRequestAttemptId

java.lang.String receiveRequestAttemptId

This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, you can retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.

• You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.

• When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.

• If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.

• You can retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).

• During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.

  If a caller of the ReceiveMessage action is still processing messages when the visibility timeout expires and messages become visible, another worker reading from the same queue can receive the same messages and therefore process duplicates. Also, if a reader whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.

  To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.

• While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible.

• If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries will work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue will remain in a strict order.

The length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation ( !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon Simple Queue Service Developer Guide.

visibilityTimeout

java.lang.Integer visibilityTimeout

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

waitTimeSeconds

java.lang.Integer waitTimeSeconds

The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.

Class com.amazonaws.services.sqs.model.ReceiveMessageResult extends java.lang.Object implements Serializable

Serialized Fields

messages

java.util.List<Message> messages

A list of messages.

Class com.amazonaws.services.sqs.model.RemovePermissionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

label

java.lang.String label

The identification of the permission to remove. This is the label added with the AddPermission action.

queueUrl

java.lang.String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Class com.amazonaws.services.sqs.model.SendMessageBatchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

entries

java.util.List<SendMessageBatchRequestEntry> entries

A list of SendMessageBatchRequestEntry items.

queueUrl

java.lang.String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Class com.amazonaws.services.sqs.model.SendMessageBatchRequestEntry extends java.lang.Object implements Serializable

Serialized Fields

delaySeconds

java.lang.Integer delaySeconds

The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive DelaySeconds value become available for processing after the delay time is finished. If you don't specify a value, the default value for the queue applies.

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

id

java.lang.String id

An identifier for the message in this batch. This is used to communicate the result. Note that the Ids of a batch request need to be unique within the request.

messageAttributes

java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes

Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide.

messageBody

java.lang.String messageBody

Body of the message.

messageDeduplicationId

java.lang.String messageDeduplicationId

This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

• Every message must have a unique MessageDeduplicationId,

  • You may provide a MessageDeduplicationId explicitly.

  • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

  • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.

  • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

• When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

• You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates.

• If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

The MessageDeduplicationId is available to the recipient of the message (this can be useful for troubleshooting delivery issues).

If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters ( a-z, A-Z, 0-9) and punctuation ( !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.

messageGroupId

java.lang.String messageGroupId

This parameter applies only to FIFO (first-in-first-out) queues.

The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion.

• You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.

• ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.

The length of MessageGroupId is 128 characters. Valid values are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.

Class com.amazonaws.services.sqs.model.SendMessageBatchResult extends java.lang.Object implements Serializable

Serialized Fields

failed

java.util.List<BatchResultErrorEntry> failed

A list of BatchResultErrorEntry items with the error detail about each message that could not be enqueued.

successful

java.util.List<SendMessageBatchResultEntry> successful

A list of SendMessageBatchResultEntry items.

Class com.amazonaws.services.sqs.model.SendMessageBatchResultEntry extends java.lang.Object implements Serializable

Serialized Fields

id

java.lang.String id

An identifier for the message in this batch.

mD5OfMessageAttributes

java.lang.String mD5OfMessageAttributes

An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message batch correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

mD5OfMessageBody

java.lang.String mD5OfMessageBody

An MD5 digest of the non-URL-encoded message body string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

messageId

java.lang.String messageId

An identifier for the message.

sequenceNumber

java.lang.String sequenceNumber

This element applies only to FIFO (first-in-first-out) queues.

A large, non-consecutive number that Amazon SQS assigns to each message.

The length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId.

Class com.amazonaws.services.sqs.model.SendMessageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

delaySeconds

java.lang.Integer delaySeconds

The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive DelaySeconds value become available for processing after the delay time is finished. If you don't specify a value, the default value for the queue applies.

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

messageAttributes

java.util.Map<java.lang.String,MessageAttributeValue> messageAttributes

Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items in the Amazon SQS Developer Guide.

messageBody

java.lang.String messageBody

The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding note.

messageDeduplicationId

java.lang.String messageDeduplicationId

This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

• Every message must have a unique MessageDeduplicationId,

  • You may provide a MessageDeduplicationId explicitly.

  • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

  • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.

  • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

• When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

• You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates.

• If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

The MessageDeduplicationId is available to the recipient of the message (this can be useful for troubleshooting delivery issues).

If a message is sent successfully but the acknowledgdment is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters ( a-z, A-Z, 0-9) and punctuation ( !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.

messageGroupId

java.lang.String messageGroupId

This parameter applies only to FIFO (first-in-first-out) queues.

The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion.

• You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.

• ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.

The length of MessageGroupId is 128 characters. Valid values are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.

queueUrl

java.lang.String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Class com.amazonaws.services.sqs.model.SendMessageResult extends java.lang.Object implements Serializable

Serialized Fields

mD5OfMessageAttributes

java.lang.String mD5OfMessageAttributes

An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

mD5OfMessageBody

java.lang.String mD5OfMessageBody

An MD5 digest of the non-URL-encoded message body string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

messageId

java.lang.String messageId

An element containing the message ID of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.

sequenceNumber

java.lang.String sequenceNumber

This element applies only to FIFO (first-in-first-out) queues.

A large, non-consecutive number that Amazon SQS assigns to each message.

The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.

Class com.amazonaws.services.sqs.model.SetQueueAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

java.util.Map<java.lang.String,java.lang.String> attributes

A map of attributes to set.

The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:

• DelaySeconds - The number of seconds for which the delivery of all messages in the queue is delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero).

• MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB).

• MessageRetentionPeriod - The number of seconds for which Amazon SQS retains a message. An integer representing seconds, from 60 (1 minute) to 120,9600 (14 days). The default is 345,600 (4 days).

• Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.

• ReceiveMessageWaitTimeSeconds - The number of seconds for which a ReceiveMessage action will wait for a message to arrive. An integer from 0 to 20 (seconds). The default is 0.

• RedrivePolicy - The parameters for the dead letter queue functionality of the source queue. For more information about the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

  The dead letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead letter queue of a standard queue must also be a standard queue.

• VisibilityTimeout - The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attribute applies only to FIFO (first-in-first-out) queues:

• ContentBasedDeduplication - Enables content-based deduplication. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

  • Every message must have a unique MessageDeduplicationId,

    • You may provide a MessageDeduplicationId explicitly.

    • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

    • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.

    • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

  • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

  • You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates.

  • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages, ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, and QueueArn) will be ignored.

queueUrl

java.lang.String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Class com.amazonaws.services.sqs.model.TooManyEntriesInBatchRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.UnsupportedOperationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.textract.model

Class com.amazonaws.services.textract.model.AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.textract.model.AnalyzeDocumentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

document

Document document

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

featureTypes

java.util.List<java.lang.String> featureTypes

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

humanLoopConfig

HumanLoopConfig humanLoopConfig

Sets the configuration for the human in the loop workflow for analyzing documents.

queriesConfig

QueriesConfig queriesConfig

Contains Queries and the alias for those Queries, as determined by the input.

Class com.amazonaws.services.textract.model.AnalyzeDocumentResult extends java.lang.Object implements Serializable

Serialized Fields

analyzeDocumentModelVersion

java.lang.String analyzeDocumentModelVersion

The version of the model used to analyze the document.

blocks

java.util.List<Block> blocks

The items that are detected and analyzed by AnalyzeDocument.

documentMetadata

DocumentMetadata documentMetadata

Metadata about the analyzed document. An example is the number of pages.

humanLoopActivationOutput

HumanLoopActivationOutput humanLoopActivationOutput

Shows the results of the human in the loop evaluation.

Class com.amazonaws.services.textract.model.AnalyzeExpenseRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

document

Document document

The input document, either as bytes or as an S3 object.

You pass image bytes to an Amazon Textract API operation by using the Bytes property. For example, you would use the Bytes property to pass a document loaded from a local file system. Image bytes passed by using the Bytes property must be base64 encoded. Your code might not need to encode document file bytes if you're using an AWS SDK to call Amazon Textract API operations.

You pass images stored in an S3 bucket to an Amazon Textract API operation by using the S3Object property. Documents stored in an S3 bucket don't need to be base64 encoded.

The AWS Region for the S3 bucket that contains the S3 object must match the AWS Region that you use for Amazon Textract operations.

If you use the AWS CLI to call Amazon Textract operations, passing image bytes using the Bytes property isn't supported. You must first upload the document to an Amazon S3 bucket, and then call the operation using the S3Object property.

For Amazon Textract to process an S3 object, the user must have permission to access the S3 object.

Class com.amazonaws.services.textract.model.AnalyzeExpenseResult extends java.lang.Object implements Serializable

Serialized Fields

documentMetadata

DocumentMetadata documentMetadata

Information about the input document.

expenseDocuments

java.util.List<ExpenseDocument> expenseDocuments

The expenses detected by Amazon Textract.

Class com.amazonaws.services.textract.model.AnalyzeIDDetections extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

The confidence score of the detected text.

Constraints:
Length: 0.0 - 100.0

normalizedValue

NormalizedValue normalizedValue

Only returned for dates, returns the type of value detected and the date written in a more machine readable way.

text

java.lang.String text

Text of either the normalized field or value associated with it.

Class com.amazonaws.services.textract.model.AnalyzeIDRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

documentPages

java.util.List<Document> documentPages

The document being passed to AnalyzeID.

Class com.amazonaws.services.textract.model.AnalyzeIDResult extends java.lang.Object implements Serializable

Serialized Fields

analyzeIDModelVersion

java.lang.String analyzeIDModelVersion

The version of the AnalyzeIdentity API being used to process documents.

documentMetadata

DocumentMetadata documentMetadata

Information about the input document.

identityDocuments

java.util.List<IdentityDocument> identityDocuments

The list of documents processed by AnalyzeID. Includes a number denoting their place in the list and the response structure for the document.

Class com.amazonaws.services.textract.model.BadDocumentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.textract.model.Block extends java.lang.Object implements Serializable

Serialized Fields

blockType

java.lang.String blockType

The type of text item that's recognized. In operations for text detection, the following types are returned:

• PAGE - Contains a list of the LINE Block objects that are detected on a document page.

• WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.

• LINE - A string of tab-delimited, contiguous words that are detected on a document page.

In text analysis operations, the following types are returned:

• PAGE - Contains a list of child Block objects that are detected on a document page.

• KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.

• WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.

• LINE - A string of tab-delimited, contiguous words that are detected on a document page.

• TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.

• CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.

• SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.

• QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attachs it to its answer.

• QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.

Constraints:
Allowed Values: KEY_VALUE_SET, PAGE, LINE, WORD, TABLE, CELL, SELECTION_ELEMENT, MERGED_CELL, TITLE, QUERY, QUERY_RESULT

columnIndex

java.lang.Integer columnIndex

The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .

Constraints:
Range: 0 -

columnSpan

java.lang.Integer columnSpan

The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

Constraints:
Range: 0 -

confidence

java.lang.Float confidence

The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.

Constraints:
Length: 0.0 - 100.0

entityTypes

java.util.List<java.lang.String> entityTypes

The type of entity. The following can be returned:

• KEY - An identifier for a field on the document.

• VALUE - The field text.

EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection .

geometry

Geometry geometry

The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.

id

java.lang.String id

The identifier for the recognized text. The identifier is only unique for a single operation.

Constraints:
Pattern: .*\S.*

page

java.lang.Integer page

The page on which a block was detected. Page is returned by asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF or TIFF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is considered to be a single-page document. The value of Page is always 1. Synchronous operations don't return Page because every input document is considered to be a single-page document.

Constraints:
Range: 0 -

query

Query query

relationships

java.util.List<Relationship> relationships

A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:

• 0 - The block has no child blocks.

• 1 - The block has child blocks.

rowIndex

java.lang.Integer rowIndex

The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

Constraints:
Range: 0 -

rowSpan

java.lang.Integer rowSpan

The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

Constraints:
Range: 0 -

selectionStatus

java.lang.String selectionStatus

The selection status of a selection element, such as an option button or check box.

Constraints:
Allowed Values: SELECTED, NOT_SELECTED

text

java.lang.String text

The word or line of text that's recognized by Amazon Textract.

textType

java.lang.String textType

The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.

Constraints:
Allowed Values: HANDWRITING, PRINTED

Class com.amazonaws.services.textract.model.BoundingBox extends java.lang.Object implements Serializable

Serialized Fields

height

java.lang.Float height

The height of the bounding box as a ratio of the overall document page height.

left

java.lang.Float left

The left coordinate of the bounding box as a ratio of overall document page width.

top

java.lang.Float top

The top coordinate of the bounding box as a ratio of overall document page height.

width

java.lang.Float width

The width of the bounding box as a ratio of the overall document page width.

Class com.amazonaws.services.textract.model.DetectDocumentTextRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

document

Document document

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

Class com.amazonaws.services.textract.model.DetectDocumentTextResult extends java.lang.Object implements Serializable

Serialized Fields

blocks

java.util.List<Block> blocks

An array of Block objects that contain the text that's detected in the document.

detectDocumentTextModelVersion

java.lang.String detectDocumentTextModelVersion

documentMetadata

DocumentMetadata documentMetadata

Metadata about the document. It contains the number of pages that are detected in the document.

Class com.amazonaws.services.textract.model.Document extends java.lang.Object implements Serializable

Serialized Fields

bytes

java.nio.ByteBuffer bytes

A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.

Constraints:
Length: 1 - 10485760

s3Object

S3Object s3Object

Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.

Class com.amazonaws.services.textract.model.DocumentLocation extends java.lang.Object implements Serializable

Serialized Fields

s3Object

S3Object s3Object

The Amazon S3 bucket that contains the input document.

Class com.amazonaws.services.textract.model.DocumentMetadata extends java.lang.Object implements Serializable

Serialized Fields

pages

java.lang.Integer pages

The number of pages that are detected in the document.

Constraints:
Range: 0 -

Class com.amazonaws.services.textract.model.DocumentTooLargeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.textract.model.ExpenseDetection extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

The confidence in detection, as a percentage

Constraints:
Length: 0.0 - 100.0

geometry

Geometry geometry

Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

text

java.lang.String text

The word or line of text recognized by Amazon Textract

Class com.amazonaws.services.textract.model.ExpenseDocument extends java.lang.Object implements Serializable

Serialized Fields

expenseIndex

java.lang.Integer expenseIndex

Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.

Constraints:
Range: 0 -

lineItemGroups

java.util.List<LineItemGroup> lineItemGroups

Information detected on each table of a document, seperated into LineItems.

summaryFields

java.util.List<ExpenseField> summaryFields

Any information found outside of a table by Amazon Textract.

Class com.amazonaws.services.textract.model.ExpenseField extends java.lang.Object implements Serializable

Serialized Fields

labelDetection

ExpenseDetection labelDetection

The explicitly stated label of a detected element.

pageNumber

java.lang.Integer pageNumber

The page number the value was detected on.

Constraints:
Range: 0 -

type

ExpenseType type

The implied label of a detected element. Present alongside LabelDetection for explicit elements.

valueDetection

ExpenseDetection valueDetection

The value of a detected element. Present in explicit and implicit elements.

Class com.amazonaws.services.textract.model.ExpenseType extends java.lang.Object implements Serializable

Serialized Fields

confidence

java.lang.Float confidence

The confidence of accuracy, as a percentage.

Constraints:
Length: 0.0 - 100.0

text

java.lang.String text

The word or line of text detected by Amazon Textract.

Class com.amazonaws.services.textract.model.Geometry extends java.lang.Object implements Serializable

Serialized Fields

boundingBox

BoundingBox boundingBox

An axis-aligned coarse representation of the location of the recognized item on the document page.

polygon

java.util.List<Point> polygon

Within the bounding box, a fine-grained polygon around the recognized item.

Class com.amazonaws.services.textract.model.GetDocumentAnalysisRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

maxResults

java.lang.Integer maxResults

The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

Constraints:
Range: 1 -

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

Constraints:
Length: 1 - 255
Pattern: .*\S.*

Class com.amazonaws.services.textract.model.GetDocumentAnalysisResult extends java.lang.Object implements Serializable

Serialized Fields

analyzeDocumentModelVersion

java.lang.String analyzeDocumentModelVersion

blocks

java.util.List<Block> blocks

The results of the text-analysis operation.

documentMetadata

DocumentMetadata documentMetadata

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

jobStatus

java.lang.String jobStatus

The current status of the text detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED, PARTIAL_SUCCESS

nextToken

java.lang.String nextToken

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.

Constraints:
Length: 1 - 255
Pattern: .*\S.*

statusMessage

java.lang.String statusMessage

Returns if the detection job could not be completed. Contains explanation for what error occured.

warnings

java.util.List<Warning> warnings

A list of warnings that occurred during the document-analysis operation.

Class com.amazonaws.services.textract.model.GetDocumentTextDetectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

A unique identifier for the text detection job. The JobId is returned from StartDocumentTextDetection. A JobId value is only valid for 7 days.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

maxResults

java.lang.Integer maxResults

The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

Constraints:
Range: 1 -

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

Constraints:
Length: 1 - 255
Pattern: .*\S.*

Class com.amazonaws.services.textract.model.GetDocumentTextDetectionResult extends java.lang.Object implements Serializable

Serialized Fields

blocks

java.util.List<Block> blocks

The results of the text-detection operation.

detectDocumentTextModelVersion

java.lang.String detectDocumentTextModelVersion

documentMetadata

DocumentMetadata documentMetadata

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

jobStatus

java.lang.String jobStatus

The current status of the text detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED, PARTIAL_SUCCESS

nextToken

java.lang.String nextToken

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results.

Constraints:
Length: 1 - 255
Pattern: .*\S.*

statusMessage

java.lang.String statusMessage

Returns if the detection job could not be completed. Contains explanation for what error occured.

warnings

java.util.List<Warning> warnings

A list of warnings that occurred during the text-detection operation for the document.

Class com.amazonaws.services.textract.model.GetExpenseAnalysisRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

A unique identifier for the text detection job. The JobId is returned from StartExpenseAnalysis. A JobId value is only valid for 7 days.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

maxResults

java.lang.Integer maxResults

The maximum number of results to return per paginated call. The largest value you can specify is 20. If you specify a value greater than 20, a maximum of 20 results is returned. The default value is 20.

Constraints:
Range: 1 -

nextToken

java.lang.String nextToken

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

Constraints:
Length: 1 - 255
Pattern: .*\S.*

Class com.amazonaws.services.textract.model.GetExpenseAnalysisResult extends java.lang.Object implements Serializable

Serialized Fields

analyzeExpenseModelVersion

java.lang.String analyzeExpenseModelVersion

The current model version of AnalyzeExpense.

documentMetadata

DocumentMetadata documentMetadata

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract operation.

expenseDocuments

java.util.List<ExpenseDocument> expenseDocuments

The expenses detected by Amazon Textract.

jobStatus

java.lang.String jobStatus

The current status of the text detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED, PARTIAL_SUCCESS

nextToken

java.lang.String nextToken

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results.

Constraints:
Length: 1 - 255
Pattern: .*\S.*

statusMessage

java.lang.String statusMessage

Returns if the detection job could not be completed. Contains explanation for what error occured.

warnings

java.util.List<Warning> warnings

A list of warnings that occurred during the text-detection operation for the document.

Class com.amazonaws.services.textract.model.HumanLoopActivationOutput extends java.lang.Object implements Serializable

Serialized Fields

humanLoopActivationConditionsEvaluationResults

java.lang.String humanLoopActivationConditionsEvaluationResults

Shows the result of condition evaluations, including those conditions which activated a human review.

Constraints:
Length: - 10240

humanLoopActivationReasons

java.util.List<java.lang.String> humanLoopActivationReasons

Shows if and why human review was needed.

humanLoopArn

java.lang.String humanLoopArn

The Amazon Resource Name (ARN) of the HumanLoop created.

Constraints:
Length: - 256

Class com.amazonaws.services.textract.model.HumanLoopConfig extends java.lang.Object implements Serializable

Serialized Fields

dataAttributes

HumanLoopDataAttributes dataAttributes

Sets attributes of the input data.

flowDefinitionArn

java.lang.String flowDefinitionArn

The Amazon Resource Name (ARN) of the flow definition.

Constraints:
Length: - 256

humanLoopName

java.lang.String humanLoopName

The name of the human workflow used for this image. This should be kept unique within a region.

Constraints:
Length: 1 - 63
Pattern: ^[a-z0-9](-*[a-z0-9])*

Class com.amazonaws.services.textract.model.HumanLoopDataAttributes extends java.lang.Object implements Serializable

Serialized Fields

contentClassifiers

java.util.List<java.lang.String> contentClassifiers

Sets whether the input image is free of personally identifiable information or adult content.

Class com.amazonaws.services.textract.model.HumanLoopQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

quotaCode

java.lang.String quotaCode

The quota code.

resourceType

java.lang.String resourceType

The resource type.

serviceCode

java.lang.String serviceCode

The service code.

Class com.amazonaws.services.textract.model.IdempotentParameterMismatchException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.textract.model.IdentityDocument extends java.lang.Object implements Serializable

Serialized Fields

documentIndex

java.lang.Integer documentIndex

Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.

Constraints:
Range: 0 -

identityDocumentFields

java.util.List<IdentityDocumentField> identityDocumentFields

The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

Class com.amazonaws.services.textract.model.IdentityDocumentField extends java.lang.Object implements Serializable

Serialized Fields

type

AnalyzeIDDetections type

Used to contain the information detected by an AnalyzeID operation.

valueDetection

AnalyzeIDDetections valueDetection

Used to contain the information detected by an AnalyzeID operation.

Class com.amazonaws.services.textract.model.InternalServerErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.textract.model.InvalidJobIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.textract.model.InvalidKMSKeyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.textract.model.InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.textract.model.InvalidS3ObjectException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.textract.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.textract.model.LineItemFields extends java.lang.Object implements Serializable

Serialized Fields

lineItemExpenseFields

java.util.List<ExpenseField> lineItemExpenseFields

ExpenseFields used to show information from detected lines on a table.

Class com.amazonaws.services.textract.model.LineItemGroup extends java.lang.Object implements Serializable

Serialized Fields

lineItemGroupIndex

java.lang.Integer lineItemGroupIndex

The number used to identify a specific table in a document. The first table encountered will have a LineItemGroupIndex of 1, the second 2, etc.

Constraints:
Range: 0 -

lineItems

java.util.List<LineItemFields> lineItems

The breakdown of information on a particular line of a table.

Class com.amazonaws.services.textract.model.NormalizedValue extends java.lang.Object implements Serializable

Serialized Fields

value

java.lang.String value

The value of the date, written as Year-Month-DayTHour:Minute:Second.

valueType

java.lang.String valueType

The normalized type of the value detected. In this case, DATE.

Constraints:
Allowed Values: DATE

Class com.amazonaws.services.textract.model.NotificationChannel extends java.lang.Object implements Serializable

Serialized Fields

roleArn

java.lang.String roleArn

The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.

Constraints:
Length: 20 - 2048
Pattern: arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

sNSTopicArn

java.lang.String sNSTopicArn

The Amazon SNS topic that Amazon Textract posts the completion status to.

Constraints:
Length: 20 - 1024
Pattern: (^arn:([a-z\d-]+):sns:[a-zA-Z\d-]{1,20}:\w{12}:.+$)

Class com.amazonaws.services.textract.model.OutputConfig extends java.lang.Object implements Serializable

Serialized Fields

s3Bucket

java.lang.String s3Bucket

The name of the bucket your output will go to.

Constraints:
Length: 3 - 255
Pattern: [0-9A-Za-z\.\-_]*

s3Prefix

java.lang.String s3Prefix

The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".

Constraints:
Length: 1 - 1024
Pattern: .*\S.*

Class com.amazonaws.services.textract.model.Point extends java.lang.Object implements Serializable

Serialized Fields

x

java.lang.Float x

The value of the X coordinate for a point on a Polygon.

y

java.lang.Float y

The value of the Y coordinate for a point on a Polygon.

Class com.amazonaws.services.textract.model.ProvisionedThroughputExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.textract.model.QueriesConfig extends java.lang.Object implements Serializable

Serialized Fields

queries

java.util.List<Query> queries

Class com.amazonaws.services.textract.model.Query extends java.lang.Object implements Serializable

Serialized Fields

alias

java.lang.String alias

Alias attached to the query, for ease of location.

Constraints:
Length: 1 - 200
Pattern: ^[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><]+$

pages

java.util.List<java.lang.String> pages

List of pages associated with the query. The following is a list of rules for using this parameter.

• If a page is not specified, it is set to ["1"] by default.

• The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.

• When using * to indicate all pages, it must be the only element in the string.

• You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates last page of document.

• Specified pages must be greater than 0 and less than or equal to the number of pages in the document.

text

java.lang.String text

Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"

Constraints:
Length: 1 - 200
Pattern: ^[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><]+$

Class com.amazonaws.services.textract.model.Relationship extends java.lang.Object implements Serializable

Serialized Fields

ids

java.util.List<java.lang.String> ids

An array of IDs for related blocks. You can get the type of the relationship from the Type element.

type

java.lang.String type

The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD. A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.

Constraints:
Allowed Values: VALUE, CHILD, COMPLEX_FEATURES, MERGED_CELL, TITLE, ANSWER

Class com.amazonaws.services.textract.model.S3Object extends java.lang.Object implements Serializable

Serialized Fields

bucket

java.lang.String bucket

The name of the S3 bucket. Note that the # character is not valid in the file name.

Constraints:
Length: 3 - 255
Pattern: [0-9A-Za-z\.\-_]*

name

java.lang.String name

The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.

Constraints:
Length: 1 - 1024
Pattern: .*\S.*

version

java.lang.String version

If the bucket has versioning enabled, you can specify the object version.

Constraints:
Length: 1 - 1024
Pattern: .*\S.*

Class com.amazonaws.services.textract.model.StartDocumentAnalysisRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

documentLocation

DocumentLocation documentLocation

The location of the document to be processed.

featureTypes

java.util.List<java.lang.String> featureTypes

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

jobTag

java.lang.String jobTag

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.\-:]+

kMSKeyId

java.lang.String kMSKeyId

The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

Constraints:
Length: 1 - 2048
Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

notificationChannel

NotificationChannel notificationChannel

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

outputConfig

OutputConfig outputConfig

Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.

queriesConfig

QueriesConfig queriesConfig

Class com.amazonaws.services.textract.model.StartDocumentAnalysisResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier for the document text detection job. Use JobId to identify the job in a subsequent call to GetDocumentAnalysis. A JobId value is only valid for 7 days.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Class com.amazonaws.services.textract.model.StartDocumentTextDetectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

documentLocation

DocumentLocation documentLocation

The location of the document to be processed.

jobTag

java.lang.String jobTag

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.\-:]+

kMSKeyId

java.lang.String kMSKeyId

The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

Constraints:
Length: 1 - 2048
Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

notificationChannel

NotificationChannel notificationChannel

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

outputConfig

OutputConfig outputConfig

Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.

Class com.amazonaws.services.textract.model.StartDocumentTextDetectionResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier of the text detection job for the document. Use JobId to identify the job in a subsequent call to GetDocumentTextDetection. A JobId value is only valid for 7 days.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Class com.amazonaws.services.textract.model.StartExpenseAnalysisRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientRequestToken

java.lang.String clientRequestToken

The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

documentLocation

DocumentLocation documentLocation

The location of the document to be processed.

jobTag

java.lang.String jobTag

An identifier you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.\-:]+

kMSKeyId

java.lang.String kMSKeyId

The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

Constraints:
Length: 1 - 2048
Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

notificationChannel

NotificationChannel notificationChannel

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

outputConfig

OutputConfig outputConfig

Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetExpenseAnalysis operation.

Class com.amazonaws.services.textract.model.StartExpenseAnalysisResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

A unique identifier for the text detection job. The JobId is returned from StartExpenseAnalysis. A JobId value is only valid for 7 days.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Class com.amazonaws.services.textract.model.ThrottlingException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.textract.model.UnsupportedDocumentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.textract.model.Warning extends java.lang.Object implements Serializable

Serialized Fields

errorCode

java.lang.String errorCode

The error code for the warning.

pages

java.util.List<java.lang.Integer> pages

A list of the pages that the warning applies to.

Package com.amazonaws.services.transcribe.model

Class com.amazonaws.services.transcribe.model.AbsoluteTimeRange extends java.lang.Object implements Serializable

Serialized Fields

endTime

java.lang.Long endTime

The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria in your audio. If you include EndTime in your request, you must also include StartTime.

Constraints:
Range: 0 - 14400000

first

java.lang.Long first

The time, in milliseconds, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Constraints:
Range: 0 - 14400000

last

java.lang.Long last

The time, in milliseconds, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

Constraints:
Range: 0 - 14400000

startTime

java.lang.Long startTime

The time, in milliseconds, when Amazon Transcribe starts searching for the specified criteria in your audio. If you include StartTime in your request, you must also include EndTime.

Constraints:
Range: 0 - 14400000

Class com.amazonaws.services.transcribe.model.BadRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.transcribe.model.CallAnalyticsJob extends java.lang.Object implements Serializable

Serialized Fields

callAnalyticsJobName

java.lang.String callAnalyticsJobName

The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

callAnalyticsJobStatus

java.lang.String callAnalyticsJobStatus

Provides the status of the specified Call Analytics job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri , if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED

channelDefinitions

java.util.List<ChannelDefinition> channelDefinitions

Allows you to specify which speaker is on which channel in your Call Analytics job request. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

completionTime

java.util.Date completionTime

The date and time the specified Call Analytics job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

creationTime

java.util.Date creationTime

The date and time the specified Call Analytics job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

For more information, see IAM ARNs.

Constraints:
Length: 20 - 2048
Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam:: [0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$

failureReason

java.lang.String failureReason

If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job request failed.

The FailureReason field contains one of the following values:

• Unsupported media format.

  The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats.

• The media format provided does not match the detected media format .

  The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

• Invalid sample rate for audio file.

  The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.

• The sample rate provided does not match the detected sample rate .

  The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

• Invalid file size: file size too large.

  The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.

• Invalid number of channels: number of channels too large.

  Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.

identifiedLanguageScore

java.lang.Float identifiedLanguageScore

The confidence score associated with the language identified in your media file.

Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

languageCode

java.lang.String languageCode

The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.

If you don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

media

Media media

Describes the Amazon S3 location of the media file you want to use in your request.

mediaFormat

java.lang.String mediaFormat

The format of the input media file.

Constraints:
Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm

mediaSampleRateHertz

java.lang.Integer mediaSampleRateHertz

The sample rate, in Hertz, of the audio track in your input media file.

Constraints:
Range: 8000 - 48000

settings

CallAnalyticsJobSettings settings

Allows additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.

startTime

java.util.Date startTime

The date and time the specified Call Analytics job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

transcript

Transcript transcript

Provides you with the Amazon S3 URI you can use to access your transcript.

Class com.amazonaws.services.transcribe.model.CallAnalyticsJobSettings extends java.lang.Object implements Serializable

Serialized Fields

contentRedaction

ContentRedaction contentRedaction

Allows you to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType.

languageIdSettings

java.util.Map<java.lang.String,LanguageIdSettings> languageIdSettings

If using automatic language identification (IdentifyLanguage ) in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters ( VocabularyName, LanguageModelName, and VocabularyFilterName).

You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.

To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.

If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter.

If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter.

languageModelName

java.lang.String languageModelName

The name of the custom language model you want to use when processing your Call Analytics job. Note that language model names are case sensitive.

The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the language model isn't applied. There are no errors or warnings associated with a language mismatch.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

languageOptions

java.util.List<java.lang.String> languageOptions

You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.

Including language options can improve the accuracy of language identification.

For a list of languages supported with Call Analytics, refer to the Supported languages table.

vocabularyFilterMethod

java.lang.String vocabularyFilterMethod

Specify how you want your vocabulary filter applied to your transcript.

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

Constraints:
Allowed Values: remove, mask, tag

vocabularyFilterName

java.lang.String vocabularyFilterName

The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Vocabulary filter names are case sensitive.

Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

vocabularyName

java.lang.String vocabularyName

The name of the custom vocabulary you want to include in your Call Analytics transcription request. Vocabulary names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.CallAnalyticsJobSummary extends java.lang.Object implements Serializable

Serialized Fields

callAnalyticsJobName

java.lang.String callAnalyticsJobName

The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

callAnalyticsJobStatus

java.lang.String callAnalyticsJobStatus

Provides the status of your Call Analytics job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri , if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED

completionTime

java.util.Date completionTime

The date and time the specified Call Analytics job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

creationTime

java.util.Date creationTime

The date and time the specified Call Analytics job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

failureReason

java.lang.String failureReason

If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed. See also: Common Errors.

languageCode

java.lang.String languageCode

The language code used to create your Call Analytics transcription.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

startTime

java.util.Date startTime

The date and time your Call Analytics job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

Class com.amazonaws.services.transcribe.model.CategoryProperties extends java.lang.Object implements Serializable

Serialized Fields

categoryName

java.lang.String categoryName

The name of the Call Analytics category. Category names are case sensitive and must be unique within an Amazon Web Services account.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

createTime

java.util.Date createTime

The date and time the specified Call Analytics category was created.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

lastUpdateTime

java.util.Date lastUpdateTime

The date and time the specified Call Analytics category was last updated.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May 5, 2022.

rules

java.util.List<Rule> rules

The rules used to define a Call Analytics category. Each category can have between 1 and 20 rules.

Class com.amazonaws.services.transcribe.model.ChannelDefinition extends java.lang.Object implements Serializable

Serialized Fields

channelId

java.lang.Integer channelId

Specify the audio channel you want to define.

Constraints:
Range: 0 - 1

participantRole

java.lang.String participantRole

Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.

Constraints:
Allowed Values: AGENT, CUSTOMER

Class com.amazonaws.services.transcribe.model.ConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.transcribe.model.ContentRedaction extends java.lang.Object implements Serializable

Serialized Fields

piiEntityTypes

java.util.List<java.lang.String> piiEntityTypes

Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.

redactionOutput

java.lang.String redactionOutput

Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.

When you choose redacted Amazon Transcribe creates only a redacted transcript.

When you choose redacted_and_unredacted Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).

Constraints:
Allowed Values: redacted, redacted_and_unredacted

redactionType

java.lang.String redactionType

Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact.

Constraints:
Allowed Values: PII

Class com.amazonaws.services.transcribe.model.CreateCallAnalyticsCategoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

categoryName

java.lang.String categoryName

A unique name, chosen by you, for your Call Analytics category. It's helpful to use a detailed naming system that will make sense to you in the future. For example, it's better to use sentiment-positive-last30seconds for a category over a generic name like test-category.

Category names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

rules

java.util.List<Rule> rules

Rules define a Call Analytics category. When creating a new Call Analytics category, you must create between 1 and 20 rules for that category. For each rule, you specify a filter you want applied to the attributes of a call. For example, you can choose a sentiment filter that detects if a customer's sentiment was positive during the last 30 seconds of the call.

Class com.amazonaws.services.transcribe.model.CreateCallAnalyticsCategoryResult extends java.lang.Object implements Serializable

Serialized Fields

categoryProperties

CategoryProperties categoryProperties

Provides you with the properties of your new category, including its associated rules.

Class com.amazonaws.services.transcribe.model.CreateLanguageModelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

baseModelName

java.lang.String baseModelName

The Amazon Transcribe standard language model, or base model, used to create your custom language model. Amazon Transcribe offers two options for base models: Wideband and Narrowband.

If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose WideBand. To transcribe audio with a sample rate less than 16,000 Hz, choose NarrowBand.

Constraints:
Allowed Values: NarrowBand, WideBand

inputDataConfig

InputDataConfig inputDataConfig

Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location.

When using InputDataConfig, you must include these sub-parameters: S3Uri, which is the Amazon S3 location of your training data, and DataAccessRoleArn, which is the Amazon Resource Name (ARN) of the role that has permission to access your specified Amazon S3 location. You can optionally include TuningDataS3Uri, which is the Amazon S3 location of your tuning data. If you specify different Amazon S3 locations for training and tuning data, the ARN you use must have permissions to access both locations.

languageCode

java.lang.String languageCode

The language code that represents the language of your model. Each language model must contain terms in only one language, and the language you select for your model must match the language of your training and tuning data.

For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that U.S. English ( en-US) is the only language supported with Amazon Transcribe Medical.

A custom language model can only be used to transcribe files in the same language as the model. For example, if you create a language model using US English (en-US), you can only apply this model to files that contain English audio.

Constraints:
Allowed Values: en-US, hi-IN, es-US, en-GB, en-AU

modelName

java.lang.String modelName

A unique name, chosen by you, for your custom language model.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new language model with the same name as an existing language model, you get a ConflictException error.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

tags

java.util.List<Tag> tags

Adds one or more custom tags, each in the form of a key:value pair, to a new custom language model at the time you create this new model.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

Class com.amazonaws.services.transcribe.model.CreateLanguageModelResult extends java.lang.Object implements Serializable

Serialized Fields

baseModelName

java.lang.String baseModelName

The Amazon Transcribe standard language model, or base model, you specified when creating your custom language model.

Constraints:
Allowed Values: NarrowBand, WideBand

inputDataConfig

InputDataConfig inputDataConfig

Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 locations you provided for your training (S3Uri) and tuning (TuningDataS3Uri) data.

languageCode

java.lang.String languageCode

The language code you selected for your custom language model.

Constraints:
Allowed Values: en-US, hi-IN, es-US, en-GB, en-AU

modelName

java.lang.String modelName

The name of your custom language model.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

modelStatus

java.lang.String modelStatus

The status of your custom language model. When the status displays as COMPLETED, your model is ready to use.

Constraints:
Allowed Values: IN_PROGRESS, FAILED, COMPLETED

Class com.amazonaws.services.transcribe.model.CreateMedicalVocabularyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language code that represents the language of the entries in your custom vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

tags

java.util.List<Tag> tags

Adds one or more custom tags, each in the form of a key:value pair, to a new medical vocabulary at the time you create this new vocabulary.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

vocabularyFileUri

java.lang.String vocabularyFileUri

The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary. The URI must be in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt

Constraints:
Length: 1 - 2000
Pattern: (s3://|http(s*)://).+

vocabularyName

java.lang.String vocabularyName

A unique name, chosen by you, for your new custom medical vocabulary.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new medical vocabulary with the same name as an existing medical vocabulary, you get a ConflictException error.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.CreateMedicalVocabularyResult extends java.lang.Object implements Serializable

Serialized Fields

failureReason

java.lang.String failureReason

If VocabularyState is FAILED, FailureReason contains information about why the medical transcription job request failed. See also: Common Errors.

languageCode

java.lang.String languageCode

The language code you selected for your medical vocabulary. US English ( en-US) is the only language supported with Amazon Transcribe Medical.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

lastModifiedTime

java.util.Date lastModifiedTime

The date and time you created your custom medical vocabulary.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

vocabularyName

java.lang.String vocabularyName

The name you chose for your custom medical vocabulary.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

vocabularyState

java.lang.String vocabularyState

The processing state of your custom medical vocabulary. If the state is READY, you can use the vocabulary in a StartMedicalTranscriptionJob request.

Constraints:
Allowed Values: PENDING, READY, FAILED

Class com.amazonaws.services.transcribe.model.CreateVocabularyFilterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language code that represents the language of the entries in your vocabulary filter. Each vocabulary filter must contain terms in only one language.

A vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a vocabulary filter using US English (en-US), you can only apply this filter to files that contain English audio.

For a list of supported languages and their associated language codes, refer to the Supported languages table.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

tags

java.util.List<Tag> tags

Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new filter.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

vocabularyFilterFileUri

java.lang.String vocabularyFilterFileUri

The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt

Note that if you include VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the other.

Constraints:
Length: 1 - 2000
Pattern: (s3://|http(s*)://).+

vocabularyFilterName

java.lang.String vocabularyFilterName

A unique name, chosen by you, for your new custom vocabulary filter.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new vocabulary filter with the same name as an existing vocabulary filter, you get a ConflictException error.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

words

java.util.List<java.lang.String> words

Use this parameter if you want to create your vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFilterFileUri parameter.

Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; you must choose one or the other.

Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

Class com.amazonaws.services.transcribe.model.CreateVocabularyFilterResult extends java.lang.Object implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language code you selected for your vocabulary filter.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

lastModifiedTime

java.util.Date lastModifiedTime

The date and time you created your vocabulary filter.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

vocabularyFilterName

java.lang.String vocabularyFilterName

The name you chose for your custom vocabulary filter.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.CreateVocabularyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language code that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language.

A custom vocabulary can only be used to transcribe files in the same language as the vocabulary. For example, if you create a vocabulary using US English (en-US), you can only apply this vocabulary to files that contain English audio.

For a list of supported languages and their associated language codes, refer to the Supported languages table.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

phrases

java.util.List<java.lang.String> phrases

Use this parameter if you want to create your vocabulary by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri parameter.

Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you must choose one or the other.

Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

tags

java.util.List<Tag> tags

Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary at the time you create this new vocabulary.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

vocabularyFileUri

java.lang.String vocabularyFileUri

The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt

Note that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you must choose one or the other.

Constraints:
Length: 1 - 2000
Pattern: (s3://|http(s*)://).+

vocabularyName

java.lang.String vocabularyName

A unique name, chosen by you, for your new custom vocabulary.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new vocabulary with the same name as an existing vocabulary, you get a ConflictException error.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.CreateVocabularyResult extends java.lang.Object implements Serializable

Serialized Fields

failureReason

java.lang.String failureReason

If VocabularyState is FAILED, FailureReason contains information about why the vocabulary request failed. See also: Common Errors.

languageCode

java.lang.String languageCode

The language code you selected for your custom vocabulary.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

lastModifiedTime

java.util.Date lastModifiedTime

The date and time you created your custom vocabulary.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

vocabularyName

java.lang.String vocabularyName

The name you chose for your custom vocabulary.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

vocabularyState

java.lang.String vocabularyState

The processing state of your custom vocabulary. If the state is READY, you can use the vocabulary in a StartTranscriptionJob request.

Constraints:
Allowed Values: PENDING, READY, FAILED

Class com.amazonaws.services.transcribe.model.DeleteCallAnalyticsCategoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

categoryName

java.lang.String categoryName

The name of the Call Analytics category you want to delete. Category names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.DeleteCallAnalyticsCategoryResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.transcribe.model.DeleteCallAnalyticsJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

callAnalyticsJobName

java.lang.String callAnalyticsJobName

The name of the Call Analytics job you want to delete. Job names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.DeleteCallAnalyticsJobResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.transcribe.model.DeleteLanguageModelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

modelName

java.lang.String modelName

The name of the custom language model you want to delete. Model names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.DeleteMedicalTranscriptionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

medicalTranscriptionJobName

java.lang.String medicalTranscriptionJobName

The name of the medical transcription job you want to delete. Job names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.DeleteMedicalVocabularyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vocabularyName

java.lang.String vocabularyName

The name of the custom medical vocabulary you want to delete. Vocabulary names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.DeleteTranscriptionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

transcriptionJobName

java.lang.String transcriptionJobName

The name of the transcription job you want to delete. Job names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.DeleteVocabularyFilterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vocabularyFilterName

java.lang.String vocabularyFilterName

The name of the custom vocabulary filter you want to delete. Vocabulary filter names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.DeleteVocabularyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vocabularyName

java.lang.String vocabularyName

The name of the custom vocabulary you want to delete. Vocabulary names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.DescribeLanguageModelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

modelName

java.lang.String modelName

The name of the custom language model you want information about. Model names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.DescribeLanguageModelResult extends java.lang.Object implements Serializable

Serialized Fields

languageModel

LanguageModel languageModel

Provides information about the specified custom language model.

This parameter also shows if the base language model you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.

If you tried to create a new custom language model and the request wasn't successful, you can use this DescribeLanguageModel to help identify the reason for this failure.

Class com.amazonaws.services.transcribe.model.GetCallAnalyticsCategoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

categoryName

java.lang.String categoryName

The name of the Call Analytics category you want information about. Category names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.GetCallAnalyticsCategoryResult extends java.lang.Object implements Serializable

Serialized Fields

categoryProperties

CategoryProperties categoryProperties

Provides you with the properties of the Call Analytics category you specified in your GetCallAnalyticsCategory request.

Class com.amazonaws.services.transcribe.model.GetCallAnalyticsJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

callAnalyticsJobName

java.lang.String callAnalyticsJobName

The name of the Call Analytics job you want information about. Job names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.GetCallAnalyticsJobResult extends java.lang.Object implements Serializable

Serialized Fields

callAnalyticsJob

CallAnalyticsJob callAnalyticsJob

Provides detailed information about the specified Call Analytics job, including job status and, if applicable, failure reason.

Class com.amazonaws.services.transcribe.model.GetMedicalTranscriptionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

medicalTranscriptionJobName

java.lang.String medicalTranscriptionJobName

The name of the medical transcription job you want information about. Job names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.GetMedicalTranscriptionJobResult extends java.lang.Object implements Serializable

Serialized Fields

medicalTranscriptionJob

MedicalTranscriptionJob medicalTranscriptionJob

Provides detailed information about the specified medical transcription job, including job status and, if applicable, failure reason.

Class com.amazonaws.services.transcribe.model.GetMedicalVocabularyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vocabularyName

java.lang.String vocabularyName

The name of the custom medical vocabulary you want information about. Vocabulary names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.GetMedicalVocabularyResult extends java.lang.Object implements Serializable

Serialized Fields

downloadUri

java.lang.String downloadUri

The S3 location where the specified medical vocabulary is stored; use this URI to view or download the vocabulary.

Constraints:
Length: 1 - 2000
Pattern: (s3://|http(s*)://).+

failureReason

java.lang.String failureReason

If VocabularyState is FAILED, FailureReason contains information about why the medical vocabulary request failed. See also: Common Errors.

languageCode

java.lang.String languageCode

The language code you selected for your medical vocabulary. US English ( en-US) is the only language supported with Amazon Transcribe Medical.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

lastModifiedTime

java.util.Date lastModifiedTime

The date and time the specified custom medical vocabulary was last modified.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

vocabularyName

java.lang.String vocabularyName

The name of the custom medical vocabulary you requested information about.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

vocabularyState

java.lang.String vocabularyState

The processing state of your custom medical vocabulary. If the state is READY, you can use the vocabulary in a StartMedicalTranscriptionJob request.

Constraints:
Allowed Values: PENDING, READY, FAILED

Class com.amazonaws.services.transcribe.model.GetTranscriptionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

transcriptionJobName

java.lang.String transcriptionJobName

The name of the transcription job you want information about. Job names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.GetTranscriptionJobResult extends java.lang.Object implements Serializable

Serialized Fields

transcriptionJob

TranscriptionJob transcriptionJob

Provides detailed information about the specified transcription job, including job status and, if applicable, failure reason.

Class com.amazonaws.services.transcribe.model.GetVocabularyFilterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vocabularyFilterName

java.lang.String vocabularyFilterName

The name of the custom vocabulary filter you want information about. Vocabulary filter names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.GetVocabularyFilterResult extends java.lang.Object implements Serializable

Serialized Fields

downloadUri

java.lang.String downloadUri

The Amazon S3 location where the vocabulary filter is stored; use this URI to view or download the vocabulary filter.

Constraints:
Length: 1 - 2000
Pattern: (s3://|http(s*)://).+

languageCode

java.lang.String languageCode

The language code you selected for your vocabulary filter.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

lastModifiedTime

java.util.Date lastModifiedTime

The date and time the specified vocabulary filter was last modified.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

vocabularyFilterName

java.lang.String vocabularyFilterName

The name of the custom vocabulary filter you requested information about.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.GetVocabularyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vocabularyName

java.lang.String vocabularyName

The name of the custom vocabulary you want information about. Vocabulary names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.GetVocabularyResult extends java.lang.Object implements Serializable

Serialized Fields

downloadUri

java.lang.String downloadUri

The S3 location where the vocabulary is stored; use this URI to view or download the vocabulary.

Constraints:
Length: 1 - 2000
Pattern: (s3://|http(s*)://).+

failureReason

java.lang.String failureReason

If VocabularyState is FAILED, FailureReason contains information about why the vocabulary request failed. See also: Common Errors.

languageCode

java.lang.String languageCode

The language code you selected for your custom vocabulary.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

lastModifiedTime

java.util.Date lastModifiedTime

The date and time the specified vocabulary was last modified.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

vocabularyName

java.lang.String vocabularyName

The name of the custom vocabulary you requested information about.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

vocabularyState

java.lang.String vocabularyState

The processing state of your custom vocabulary. If the state is READY, you can use the vocabulary in a StartTranscriptionJob request.

Constraints:
Allowed Values: PENDING, READY, FAILED

Class com.amazonaws.services.transcribe.model.InputDataConfig extends java.lang.Object implements Serializable

Serialized Fields

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

For more information, see IAM ARNs.

Constraints:
Length: 20 - 2048
Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam:: [0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$

s3Uri

java.lang.String s3Uri

The Amazon S3 location (URI) of the text files you want to use to train your custom language model.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/

Constraints:
Length: 1 - 2000
Pattern: (s3://|http(s*)://).+

tuningDataS3Uri

java.lang.String tuningDataS3Uri

The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/

Constraints:
Length: 1 - 2000
Pattern: (s3://|http(s*)://).+

Class com.amazonaws.services.transcribe.model.InternalFailureException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.transcribe.model.InterruptionFilter extends java.lang.Object implements Serializable

Serialized Fields

absoluteTimeRange

AbsoluteTimeRange absoluteTimeRange

Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for an interruption. See for more detail.

negate

java.lang.Boolean negate

Set to TRUE to flag speech that does not contain interruptions. Set to FALSE to flag speech that contains interruptions.

participantRole

java.lang.String participantRole

Specify the interrupter you want to flag. Omitting this parameter is equivalent to specifying both participants.

Constraints:
Allowed Values: AGENT, CUSTOMER

relativeTimeRange

RelativeTimeRange relativeTimeRange

Allows you to specify a time range (in percentage) in your media file, during which you want to search for an interruption. See for more detail.

threshold

java.lang.Long threshold

Specify the duration of the interruptions in milliseconds. For example, you can flag speech that contains more than 10000 milliseconds of interruptions.

Constraints:
Range: 0 - 14400000

Class com.amazonaws.services.transcribe.model.JobExecutionSettings extends java.lang.Object implements Serializable

Serialized Fields

allowDeferredExecution

java.lang.Boolean allowDeferredExecution

Allows you to enable job queuing when your concurrent request limit is exceeded. When AllowDeferredExecution is set to true, transcription job requests are placed in a queue until the number of jobs falls below the concurrent request limit. If AllowDeferredExecution is set to false and the number of transcription job requests exceed the concurrent request limit, you get a LimitExceededException error.

Note that job queuing is enabled by default for Call Analytics jobs.

If you include AllowDeferredExecution in your request, you must also include DataAccessRoleArn.

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.

Note that if you include DataAccessRoleArn in your request, you must also include AllowDeferredExecution.

Constraints:
Length: 20 - 2048
Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam:: [0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$

Class com.amazonaws.services.transcribe.model.LanguageCodeItem extends java.lang.Object implements Serializable

Serialized Fields

durationInSeconds

java.lang.Float durationInSeconds

Provides the total time, in seconds, each identified language is spoken in your media.

languageCode

java.lang.String languageCode

Provides the language code for each language identified in your media.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

Class com.amazonaws.services.transcribe.model.LanguageIdSettings extends java.lang.Object implements Serializable

Serialized Fields

languageModelName

java.lang.String languageModelName

The name of the custom language model you want to use when processing your transcription job. Note that language model names are case sensitive.

The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the language model isn't applied. There are no errors or warnings associated with a language mismatch.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

vocabularyFilterName

java.lang.String vocabularyFilterName

The name of the custom vocabulary filter you want to use when processing your transcription job. Vocabulary filter names are case sensitive.

The language of the specified vocabulary filter must match the language code you specify in your transcription request. If the languages don't match, the vocabulary filter isn't applied. There are no errors or warnings associated with a language mismatch.

Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

vocabularyName

java.lang.String vocabularyName

The name of the custom vocabulary you want to use when processing your transcription job. Vocabulary names are case sensitive.

The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the vocabulary isn't applied. There are no errors or warnings associated with a language mismatch.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.LanguageModel extends java.lang.Object implements Serializable

Serialized Fields

baseModelName

java.lang.String baseModelName

The Amazon Transcribe standard language model, or base model, used to create your custom language model.

Constraints:
Allowed Values: NarrowBand, WideBand

createTime

java.util.Date createTime

The date and time the specified custom language model was created.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

failureReason

java.lang.String failureReason

If ModelStatus is FAILED, FailureReason contains information about why the custom language model request failed. See also: Common Errors.

inputDataConfig

InputDataConfig inputDataConfig

The Amazon S3 location of the input files used to train and tune your custom language model, in addition to the data access role ARN (Amazon Resource Name) that has permissions to access these data.

languageCode

java.lang.String languageCode

The language code used to create your custom language model. Each language model must contain terms in only one language, and the language you select for your model must match the language of your training and tuning data.

For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that U.S. English ( en-US) is the only language supported with Amazon Transcribe Medical.

Constraints:
Allowed Values: en-US, hi-IN, es-US, en-GB, en-AU

lastModifiedTime

java.util.Date lastModifiedTime

The date and time the specified language model was last modified.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

modelName

java.lang.String modelName

A unique name, chosen by you, for your custom language model.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

modelStatus

java.lang.String modelStatus

The status of the specified custom language model. When the status displays as COMPLETED the model is ready for use.

Constraints:
Allowed Values: IN_PROGRESS, FAILED, COMPLETED

upgradeAvailability

java.lang.Boolean upgradeAvailability

Shows if a more current base model is available for use with the specified custom language model.

If false, your language model is using the most up-to-date base model.

If true, there is a newer base model available than the one your language model is using.

Note that to update a base model, you must recreate the custom language model using the new base model. Base model upgrades for existing custom language models are not supported.

Class com.amazonaws.services.transcribe.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.transcribe.model.ListCallAnalyticsCategoriesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of Call Analytics categories to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

If your ListCallAnalyticsCategories request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

Constraints:
Length: - 8192
Pattern: .+

Class com.amazonaws.services.transcribe.model.ListCallAnalyticsCategoriesResult extends java.lang.Object implements Serializable

Serialized Fields

categories

java.util.List<CategoryProperties> categories

Provides detailed information about your Call Analytics categories, including all the rules associated with each category.

nextToken

java.lang.String nextToken

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

Constraints:
Length: - 8192
Pattern: .+

Class com.amazonaws.services.transcribe.model.ListCallAnalyticsJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobNameContains

java.lang.String jobNameContains

Returns only the Call Analytics jobs that contain the specified string. The search is not case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

maxResults

java.lang.Integer maxResults

The maximum number of Call Analytics jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

If your ListCallAnalyticsJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

Constraints:
Length: - 8192
Pattern: .+

status

java.lang.String status

Returns only Call Analytics jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all Call Analytics jobs are returned.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED

Class com.amazonaws.services.transcribe.model.ListCallAnalyticsJobsResult extends java.lang.Object implements Serializable

Serialized Fields

callAnalyticsJobSummaries

java.util.List<CallAnalyticsJobSummary> callAnalyticsJobSummaries

Provides a summary of information about each result.

nextToken

java.lang.String nextToken

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

Constraints:
Length: - 8192
Pattern: .+

status

java.lang.String status

Lists all Call Analytics jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED

Class com.amazonaws.services.transcribe.model.ListLanguageModelsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of custom language models to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

Constraints:
Range: 1 - 100

nameContains

java.lang.String nameContains

Returns only the custom language models that contain the specified string. The search is not case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

nextToken

java.lang.String nextToken

If your ListLanguageModels request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

Constraints:
Length: - 8192
Pattern: .+

statusEquals

java.lang.String statusEquals

Returns only custom language models with the specified status. Language models are ordered by creation date, with the newest model first. If you don't include StatusEquals, all custom language models are returned.

Constraints:
Allowed Values: IN_PROGRESS, FAILED, COMPLETED

Class com.amazonaws.services.transcribe.model.ListLanguageModelsResult extends java.lang.Object implements Serializable

Serialized Fields

models

java.util.List<LanguageModel> models

Provides information about the custom language models that match the criteria specified in your request.

nextToken

java.lang.String nextToken

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

Constraints:
Length: - 8192
Pattern: .+

Class com.amazonaws.services.transcribe.model.ListMedicalTranscriptionJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobNameContains

java.lang.String jobNameContains

Returns only the medical transcription jobs that contain the specified string. The search is not case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

maxResults

java.lang.Integer maxResults

The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

If your ListMedicalTranscriptionJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

Constraints:
Length: - 8192
Pattern: .+

status

java.lang.String status

Returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all medical transcription jobs are returned.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED

Class com.amazonaws.services.transcribe.model.ListMedicalTranscriptionJobsResult extends java.lang.Object implements Serializable

Serialized Fields

medicalTranscriptionJobSummaries

java.util.List<MedicalTranscriptionJobSummary> medicalTranscriptionJobSummaries

Provides a summary of information about each result.

nextToken

java.lang.String nextToken

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

Constraints:
Length: - 8192
Pattern: .+

status

java.lang.String status

Lists all medical transcription jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED

Class com.amazonaws.services.transcribe.model.ListMedicalVocabulariesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of custom medical vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

Constraints:
Range: 1 - 100

nameContains

java.lang.String nameContains

Returns only the custom medical vocabularies that contain the specified string. The search is not case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

nextToken

java.lang.String nextToken

If your ListMedicalVocabularies request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

Constraints:
Length: - 8192
Pattern: .+

stateEquals

java.lang.String stateEquals

Returns only custom medical vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you don't include StateEquals, all custom medical vocabularies are returned.

Constraints:
Allowed Values: PENDING, READY, FAILED

Class com.amazonaws.services.transcribe.model.ListMedicalVocabulariesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

Constraints:
Length: - 8192
Pattern: .+

status

java.lang.String status

Lists all custom medical vocabularies that have the status specified in your request. Vocabularies are ordered by creation date, with the newest vocabulary first.

Constraints:
Allowed Values: PENDING, READY, FAILED

vocabularies

java.util.List<VocabularyInfo> vocabularies

Provides information about the custom medical vocabularies that match the criteria specified in your request.

Class com.amazonaws.services.transcribe.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

Returns a list of all tags associated with the specified Amazon Resource Name (ARN). ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id .

For example, arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name .

Valid values for resource-type are: transcription-job, medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, and language-model.

Constraints:
Length: 1 - 1011
Pattern: arn:aws(-[^:]+)?:transcribe:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z-] */[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.ListTagsForResourceResult extends java.lang.Object implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) specified in your request.

Constraints:
Length: 1 - 1011
Pattern: arn:aws(-[^:]+)?:transcribe:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z-] */[0-9a-zA-Z._-]+

tags

java.util.List<Tag> tags

Lists all tags associated with the given transcription job, vocabulary, model, or resource.

Class com.amazonaws.services.transcribe.model.ListTranscriptionJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobNameContains

java.lang.String jobNameContains

Returns only the transcription jobs that contain the specified string. The search is not case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

maxResults

java.lang.Integer maxResults

The maximum number of transcription jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

Constraints:
Range: 1 - 100

nextToken

java.lang.String nextToken

If your ListTranscriptionJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

Constraints:
Length: - 8192
Pattern: .+

status

java.lang.String status

Returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all transcription jobs are returned.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED

Class com.amazonaws.services.transcribe.model.ListTranscriptionJobsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

Constraints:
Length: - 8192
Pattern: .+

status

java.lang.String status

Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED

transcriptionJobSummaries

java.util.List<TranscriptionJobSummary> transcriptionJobSummaries

Provides a summary of information about each result.

Class com.amazonaws.services.transcribe.model.ListVocabulariesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of custom vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

Constraints:
Range: 1 - 100

nameContains

java.lang.String nameContains

Returns only the custom vocabularies that contain the specified string. The search is not case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

nextToken

java.lang.String nextToken

If your ListVocabularies request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

Constraints:
Length: - 8192
Pattern: .+

stateEquals

java.lang.String stateEquals

Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you don't include StateEquals, all custom medical vocabularies are returned.

Constraints:
Allowed Values: PENDING, READY, FAILED

Class com.amazonaws.services.transcribe.model.ListVocabulariesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

Constraints:
Length: - 8192
Pattern: .+

status

java.lang.String status

Lists all custom vocabularies that have the status specified in your request. Vocabularies are ordered by creation date, with the newest vocabulary first.

Constraints:
Allowed Values: PENDING, READY, FAILED

vocabularies

java.util.List<VocabularyInfo> vocabularies

Provides information about the custom vocabularies that match the criteria specified in your request.

Class com.amazonaws.services.transcribe.model.ListVocabularyFiltersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of custom vocabulary filters to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

Constraints:
Range: 1 - 100

nameContains

java.lang.String nameContains

Returns only the custom vocabulary filters that contain the specified string. The search is not case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

nextToken

java.lang.String nextToken

If your ListVocabularyFilters request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

Constraints:
Length: - 8192
Pattern: .+

Class com.amazonaws.services.transcribe.model.ListVocabularyFiltersResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

Constraints:
Length: - 8192
Pattern: .+

vocabularyFilters

java.util.List<VocabularyFilterInfo> vocabularyFilters

Provides information about the custom vocabulary filters that match the criteria specified in your request.

Class com.amazonaws.services.transcribe.model.Media extends java.lang.Object implements Serializable

Serialized Fields

mediaFileUri

java.lang.String mediaFileUri

The Amazon S3 location of the media file you want to transcribe. For example:

• s3://DOC-EXAMPLE-BUCKET/my-media-file.flac

• s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

Constraints:
Length: 1 - 2000
Pattern: (s3://|http(s*)://).+

redactedMediaFileUri

java.lang.String redactedMediaFileUri

The Amazon S3 location of the media file you want to redact. For example:

• s3://DOC-EXAMPLE-BUCKET/my-media-file.flac

• s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

RedactedMediaFileUri is only supported for Call Analytics ( StartCallAnalyticsJob) transcription requests.

Constraints:
Length: 1 - 2000
Pattern: (s3://|http(s*)://).+

Class com.amazonaws.services.transcribe.model.MedicalTranscript extends java.lang.Object implements Serializable

Serialized Fields

transcriptFileUri

java.lang.String transcriptFileUri

The Amazon S3 location of your transcript. You can use this URI to access or download your transcript.

If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.

If you didn't include OutputBucketName in your transcription job request, your transcript is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your transcript.

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request.

Constraints:
Length: 1 - 2000
Pattern: (s3://|http(s*)://).+

Class com.amazonaws.services.transcribe.model.MedicalTranscriptionJob extends java.lang.Object implements Serializable

Serialized Fields

completionTime

java.util.Date completionTime

The date and time the specified medical transcription job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

contentIdentificationType

java.lang.String contentIdentificationType

Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.

Constraints:
Allowed Values: PHI

creationTime

java.util.Date creationTime

The date and time the specified medical transcription job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

failureReason

java.lang.String failureReason

If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.

The FailureReason field contains one of the following values:

• Unsupported media format.

  The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats.

• The media format provided does not match the detected media format .

  The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

• Invalid sample rate for audio file.

  The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 16,000 and 48,000 Hertz.

• The sample rate provided does not match the detected sample rate .

  The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

• Invalid file size: file size too large.

  The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.

• Invalid number of channels: number of channels too large.

  Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.

languageCode

java.lang.String languageCode

The language code used to create your medical transcription job. US English (en-US) is the only supported language for medical transcriptions.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

media

Media media

Describes the Amazon S3 location of the media file you want to use in your request.

mediaFormat

java.lang.String mediaFormat

The format of the input media file.

Constraints:
Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm

mediaSampleRateHertz

java.lang.Integer mediaSampleRateHertz

The sample rate, in Hertz, of the audio track in your input media file.

Constraints:
Range: 16000 - 48000

medicalTranscriptionJobName

java.lang.String medicalTranscriptionJobName

The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

settings

MedicalTranscriptionSetting settings

Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your medical transcription job.

specialty

java.lang.String specialty

Describes the medical specialty represented in your media.

Constraints:
Allowed Values: PRIMARYCARE

startTime

java.util.Date startTime

The date and time the specified medical transcription job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

tags

java.util.List<Tag> tags

The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.

transcript

MedicalTranscript transcript

Provides you with the Amazon S3 URI you can use to access your transcript.

transcriptionJobStatus

java.lang.String transcriptionJobStatus

Provides the status of the specified medical transcription job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED

type

java.lang.String type

Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

Constraints:
Allowed Values: CONVERSATION, DICTATION

Class com.amazonaws.services.transcribe.model.MedicalTranscriptionJobSummary extends java.lang.Object implements Serializable

Serialized Fields

completionTime

java.util.Date completionTime

The date and time the specified medical transcription job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

contentIdentificationType

java.lang.String contentIdentificationType

Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.

Constraints:
Allowed Values: PHI

creationTime

java.util.Date creationTime

The date and time the specified medical transcription job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

failureReason

java.lang.String failureReason

If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.

languageCode

java.lang.String languageCode

The language code used to create your medical transcription. US English ( en-US) is the only supported language for medical transcriptions.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

medicalTranscriptionJobName

java.lang.String medicalTranscriptionJobName

The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

outputLocationType

java.lang.String outputLocationType

Indicates where the specified medical transcription output is stored.

If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.

If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri field.

Constraints:
Allowed Values: CUSTOMER_BUCKET, SERVICE_BUCKET

specialty

java.lang.String specialty

Provides the medical specialty represented in your media.

Constraints:
Allowed Values: PRIMARYCARE

startTime

java.util.Date startTime

The date and time your medical transcription job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

transcriptionJobStatus

java.lang.String transcriptionJobStatus

Provides the status of your medical transcription job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED

type

java.lang.String type

Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

Constraints:
Allowed Values: CONVERSATION, DICTATION

Class com.amazonaws.services.transcribe.model.MedicalTranscriptionSetting extends java.lang.Object implements Serializable

Serialized Fields

channelIdentification

java.lang.Boolean channelIdentification

Enables channel identification in multi-channel audio.

Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

For more information, see Transcribing multi-channel audio.

maxAlternatives

java.lang.Integer maxAlternatives

Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.

If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.

If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

For more information, see Alternative transcriptions.

Constraints:
Range: 2 - 10

maxSpeakerLabels

java.lang.Integer maxSpeakerLabels

Specify the maximum number of speakers you want to identify in your media.

Note that if your media contains more speakers than the specified number, multiple speakers will be identified as a single speaker.

If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

Constraints:
Range: 2 - 10

showAlternatives

java.lang.Boolean showAlternatives

To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.

For more information, see Alternative transcriptions.

showSpeakerLabels

java.lang.Boolean showSpeakerLabels

Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.

If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

For more information, see Identifying speakers (diarization).

vocabularyName

java.lang.String vocabularyName

The name of the custom vocabulary you want to use when processing your medical transcription job. Vocabulary names are case sensitive.

The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.ModelSettings extends java.lang.Object implements Serializable

Serialized Fields

languageModelName

java.lang.String languageModelName

The name of the custom language model you want to use when processing your transcription job. Note that language model names are case sensitive.

The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the language model isn't applied. There are no errors or warnings associated with a language mismatch.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.NonTalkTimeFilter extends java.lang.Object implements Serializable

Serialized Fields

absoluteTimeRange

AbsoluteTimeRange absoluteTimeRange

Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for a period of silence. See for more detail.

negate

java.lang.Boolean negate

Set to TRUE to flag periods of speech. Set to FALSE to flag periods of silence

relativeTimeRange

RelativeTimeRange relativeTimeRange

Allows you to specify a time range (in percentage) in your media file, during which you want to search for a period of silence. See for more detail.

threshold

java.lang.Long threshold

Specify the duration, in milliseconds, of the period of silence you want to flag. For example, you can flag a silent period that lasts 30000 milliseconds.

Constraints:
Range: 0 - 14400000

Class com.amazonaws.services.transcribe.model.NotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.transcribe.model.RelativeTimeRange extends java.lang.Object implements Serializable

Serialized Fields

endPercentage

java.lang.Integer endPercentage

The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage.

Constraints:
Range: 0 - 100

first

java.lang.Integer first

The time, in percentage, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.

Constraints:
Range: 0 - 100

last

java.lang.Integer last

The time, in percentage, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.

Constraints:
Range: 0 - 100

startPercentage

java.lang.Integer startPercentage

The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage.

Constraints:
Range: 0 - 100

Class com.amazonaws.services.transcribe.model.Rule extends java.lang.Object implements Serializable

Serialized Fields

interruptionFilter

InterruptionFilter interruptionFilter

Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more detail.

nonTalkTimeFilter

NonTalkTimeFilter nonTalkTimeFilter

Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more detail.

sentimentFilter

SentimentFilter sentimentFilter

Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for more detail.

transcriptFilter

TranscriptFilter transcriptFilter

Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to for more detail.

Class com.amazonaws.services.transcribe.model.SentimentFilter extends java.lang.Object implements Serializable

Serialized Fields

absoluteTimeRange

AbsoluteTimeRange absoluteTimeRange

Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.

negate

java.lang.Boolean negate

Set to TRUE to flag the sentiments you didn't include in your request. Set to FALSE to flag the sentiments you specified in your request.

participantRole

java.lang.String participantRole

Specify the participant you want to flag. Omitting this parameter is equivalent to specifying both participants.

Constraints:
Allowed Values: AGENT, CUSTOMER

relativeTimeRange

RelativeTimeRange relativeTimeRange

Allows you to specify a time range (in percentage) in your media file, during which you want to search for the specified sentiments. See for more detail.

sentiments

java.util.List<java.lang.String> sentiments

Specify the sentiments you want to flag.

Class com.amazonaws.services.transcribe.model.Settings extends java.lang.Object implements Serializable

Serialized Fields

channelIdentification

java.lang.Boolean channelIdentification

Enables channel identification in multi-channel audio.

Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

For more information, see Transcribing multi-channel audio.

maxAlternatives

java.lang.Integer maxAlternatives

Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.

If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.

If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

For more information, see Alternative transcriptions.

Constraints:
Range: 2 - 10

maxSpeakerLabels

java.lang.Integer maxSpeakerLabels

Specify the maximum number of speakers you want to identify in your media.

Note that if your media contains more speakers than the specified number, multiple speakers will be identified as a single speaker.

If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

Constraints:
Range: 2 - 10

showAlternatives

java.lang.Boolean showAlternatives

To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.

If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.

For more information, see Alternative transcriptions.

showSpeakerLabels

java.lang.Boolean showSpeakerLabels

Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.

If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.

For more information, see Identifying speakers (diarization).

vocabularyFilterMethod

java.lang.String vocabularyFilterMethod

Specify how you want your vocabulary filter applied to your transcript.

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

Constraints:
Allowed Values: remove, mask, tag

vocabularyFilterName

java.lang.String vocabularyFilterName

The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

vocabularyName

java.lang.String vocabularyName

The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.StartCallAnalyticsJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

callAnalyticsJobName

java.lang.String callAnalyticsJobName

A unique name, chosen by you, for your Call Analytics job.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

channelDefinitions

java.util.List<ChannelDefinition> channelDefinitions

Allows you to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

For more information, see IAM ARNs.

Constraints:
Length: 20 - 2048
Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam:: [0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$

media

Media media

Describes the Amazon S3 location of the media file you want to use in your request.

outputEncryptionKMSKeyId

java.lang.String outputEncryptionKMSKeyId

The KMS key you want to use to encrypt your Call Analytics output.

If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:

1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.

3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab .

4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:

1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab .

2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location using the OutputLocation parameter.

Note that the user making the request must have permission to use the specified KMS key.

Constraints:
Length: 1 - 2048
Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

outputLocation

java.lang.String outputLocation

The Amazon S3 location where you want your Call Analytics transcription output stored. You can use any of the following formats to specify the output location:

1. s3://DOC-EXAMPLE-BUCKET

2. s3://DOC-EXAMPLE-BUCKET/my-output-folder/

3. s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json

Unless you specify a file name (option 3), the name of your output file has a default value that matches the name you specified for your transcription job using the CallAnalyticsJobName parameter.

You can specify a KMS key to encrypt your output using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption.

If you don't specify OutputLocation, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.

Constraints:
Length: 1 - 2000
Pattern: (s3://|http(s*)://).+

settings

CallAnalyticsJobSettings settings

Specify additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.

Class com.amazonaws.services.transcribe.model.StartCallAnalyticsJobResult extends java.lang.Object implements Serializable

Serialized Fields

callAnalyticsJob

CallAnalyticsJob callAnalyticsJob

Provides detailed information about the current Call Analytics job, including job status and, if applicable, failure reason.

Class com.amazonaws.services.transcribe.model.StartMedicalTranscriptionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contentIdentificationType

java.lang.String contentIdentificationType

Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.

Constraints:
Allowed Values: PHI

kMSEncryptionContext

java.util.Map<java.lang.String,java.lang.String> kMSEncryptionContext

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.

languageCode

java.lang.String languageCode

The language code that represents the language spoken in the input media file. US English (en-US) is the only valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

media

Media media

Describes the Amazon S3 location of the media file you want to use in your request.

mediaFormat

java.lang.String mediaFormat

Specify the format of your input media file.

Constraints:
Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm

mediaSampleRateHertz

java.lang.Integer mediaSampleRateHertz

The sample rate, in Hertz, of the audio track in your input media file.

If you don't specify the media sample rate, Amazon Transcribe Medical determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value you specify and the value detected, your job fails. Therefore, in most cases, it's advised to omit MediaSampleRateHertz and let Amazon Transcribe Medical determine the sample rate.

Constraints:
Range: 16000 - 48000

medicalTranscriptionJobName

java.lang.String medicalTranscriptionJobName

A unique name, chosen by you, for your medical transcription job. The name you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the OutputKey parameter.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

outputBucketName

java.lang.String outputBucketName

The name of the Amazon S3 bucket where you want your medical transcription output stored. Do not include the S3:// prefix of the specified bucket.

If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket.

For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/.

Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

If you don't specify OutputBucketName, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.

Constraints:
Length: - 64
Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]

outputEncryptionKMSKeyId

java.lang.String outputEncryptionKMSKeyId

The KMS key you want to use to encrypt your medical transcription output.

If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:

1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.

3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab .

4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:

1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab .

2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location using the OutputLocation parameter.

Note that the user making the request must have permission to use the specified KMS key.

Constraints:
Length: 1 - 2048
Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

outputKey

java.lang.String outputKey

Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your medical transcription job ( MedicalTranscriptionJobName).

Here are some examples of how you can use OutputKey:

• If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.

• If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json .

• If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.

• If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json .

If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.

Constraints:
Length: 1 - 1024
Pattern: [a-zA-Z0-9-_.!*'()/]{1,1024}$

settings

MedicalTranscriptionSetting settings

Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your transcription job.

specialty

java.lang.String specialty

Specify the predominant medical specialty represented in your media. For batch transcriptions, PRIMARYCARE is the only valid value. If you require additional specialties, refer to .

Constraints:
Allowed Values: PRIMARYCARE

tags

java.util.List<Tag> tags

Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the time you start this new job.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

type

java.lang.String type

Specify whether your input media contains only one person ( DICTATION) or contains a conversation between two people ( CONVERSATION).

For example, DICTATION could be used for a medical professional wanting to transcribe voice memos; CONVERSATION could be used for transcribing the doctor-patient dialogue during the patient's office visit.

Constraints:
Allowed Values: CONVERSATION, DICTATION

Class com.amazonaws.services.transcribe.model.StartMedicalTranscriptionJobResult extends java.lang.Object implements Serializable

Serialized Fields

medicalTranscriptionJob

MedicalTranscriptionJob medicalTranscriptionJob

Provides detailed information about the current medical transcription job, including job status and, if applicable, failure reason.

Class com.amazonaws.services.transcribe.model.StartTranscriptionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contentRedaction

ContentRedaction contentRedaction

Allows you to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType.

identifyLanguage

java.lang.Boolean identifyLanguage

Enables automatic language identification in your transcription job request.

If you include IdentifyLanguage, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including language options can improve transcription accuracy.

If you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).

Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

identifyMultipleLanguages

java.lang.Boolean identifyMultipleLanguages

Enables automatic multi-language identification in your transcription job request. Use this parameter if your media file contains more than one language.

If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including language options can improve transcription accuracy.

If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters ( VocabularyName and VocabularyFilterName).

Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

jobExecutionSettings

JobExecutionSettings jobExecutionSettings

Allows you to control how your transcription job is processed. Currently, the only JobExecutionSettings modification you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter.

If you include JobExecutionSettings in your request, you must also include the sub-parameters: AllowDeferredExecution and DataAccessRoleArn.

kMSEncryptionContext

java.util.Map<java.lang.String,java.lang.String> kMSEncryptionContext

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.

languageCode

java.lang.String languageCode

The language code that represents the language spoken in the input media file.

If you're unsure of the language spoken in your media file, consider using IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language identification.

Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

For a list of supported languages and their associated language codes, refer to the Supported languages table.

To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

languageIdSettings

java.util.Map<java.lang.String,LanguageIdSettings> languageIdSettings

If using automatic language identification (IdentifyLanguage ) in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters ( VocabularyName, LanguageModelName, and VocabularyFilterName).

You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.

To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.

If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter.

If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter.

languageOptions

java.util.List<java.lang.String> languageOptions

You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.

If you include LanguageOptions in your request, you must also include IdentifyLanguage.

For more information, refer to Supported languages.

To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

media

Media media

Describes the Amazon S3 location of the media file you want to use in your request.

mediaFormat

java.lang.String mediaFormat

Specify the format of your input media file.

Constraints:
Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm

mediaSampleRateHertz

java.lang.Integer mediaSampleRateHertz

The sample rate, in Hertz, of the audio track in your input media file.

If you don't specify the media sample rate, Amazon Transcribe determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe; if there's a mismatch between the value you specify and the value detected, your job fails. Therefore, in most cases, it's advised to omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.

Constraints:
Range: 8000 - 48000

modelSettings

ModelSettings modelSettings

Specify the custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter.

For more information, see Custom language models.

outputBucketName

java.lang.String outputBucketName

The name of the Amazon S3 bucket where you want your transcription output stored. Do not include the S3:// prefix of the specified bucket.

If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket.

For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/.

Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

If you don't specify OutputBucketName, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.

Constraints:
Length: - 64
Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]

outputEncryptionKMSKeyId

java.lang.String outputEncryptionKMSKeyId

The KMS key you want to use to encrypt your transcription output.

If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:

1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.

3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab .

4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:

1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab .

2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location using the OutputLocation parameter.

Note that the user making the request must have permission to use the specified KMS key.

Constraints:
Length: 1 - 2048
Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

outputKey

java.lang.String outputKey

Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your transcription job ( TranscriptionJobName).

Here are some examples of how you can use OutputKey:

• If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.

• If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json .

• If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.

• If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json .

If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.

Constraints:
Length: 1 - 1024
Pattern: [a-zA-Z0-9-_.!*'()/]{1,1024}$

settings

Settings settings

Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker labeling; allows you to apply custom vocabularies and vocabulary filters.

If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter.

If you're using automatic language identification with your request and want to include a custom language model, a custom vocabulary, or a custom vocabulary filter, use instead the parameter with the LanguageModelName, VocabularyName or VocabularyFilterName sub-parameters.

subtitles

Subtitles subtitles

Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and SubRip (*.srt) formats.

tags

java.util.List<Tag> tags

Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

transcriptionJobName

java.lang.String transcriptionJobName

A unique name, chosen by you, for your transcription job. The name you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the OutputKey parameter.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.StartTranscriptionJobResult extends java.lang.Object implements Serializable

Serialized Fields

transcriptionJob

TranscriptionJob transcriptionJob

Provides detailed information about the current transcription job, including job status and, if applicable, failure reason.

Class com.amazonaws.services.transcribe.model.Subtitles extends java.lang.Object implements Serializable

Serialized Fields

formats

java.util.List<java.lang.String> formats

Specify the output format for your subtitle file; if you select both WebVTT (vtt) and SubRip (srt) formats, two output files are generated.

outputStartIndex

java.lang.Integer outputStartIndex

Specify the starting value that is assigned to the first subtitle segment.

The default start index for Amazon Transcribe is 0, which differs from the more widely used standard of 1. If you're uncertain which value to use, we recommend choosing 1, as this may improve compatibility with other services.

Constraints:
Range: 0 - 1

Class com.amazonaws.services.transcribe.model.SubtitlesOutput extends java.lang.Object implements Serializable

Serialized Fields

formats

java.util.List<java.lang.String> formats

Provides the format of your subtitle files. If your request included both WebVTT (vtt) and SubRip (srt) formats, both formats are shown.

outputStartIndex

java.lang.Integer outputStartIndex

Provides the start index value for your subtitle files. If you did not specify a value in your request, the default value of 0 is used.

Constraints:
Range: 0 - 1

subtitleFileUris

java.util.List<java.lang.String> subtitleFileUris

The Amazon S3 location of your transcript. You can use this URI to access or download your subtitle file. Your subtitle file is stored in the same location as your transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are provided.

If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.

If you didn't include OutputBucketName in your transcription job request, your subtitle file is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your subtitle file.

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request.

Class com.amazonaws.services.transcribe.model.Tag extends java.lang.Object implements Serializable

Serialized Fields

key

java.lang.String key

The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is 'Department'.

Constraints:
Length: 1 - 128

value

java.lang.String value

The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the value is 'Sales'.

Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.

Constraints:
Length: 0 - 256

Class com.amazonaws.services.transcribe.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id .

For example, arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name .

Valid values for resource-type are: transcription-job, medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, and language-model.

Constraints:
Length: 1 - 1011
Pattern: arn:aws(-[^:]+)?:transcribe:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z-] */[0-9a-zA-Z._-]+

tags

java.util.List<Tag> tags

Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

Class com.amazonaws.services.transcribe.model.TagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.transcribe.model.Transcript extends java.lang.Object implements Serializable

Serialized Fields

redactedTranscriptFileUri

java.lang.String redactedTranscriptFileUri

The Amazon S3 location of your redacted transcript. You can use this URI to access or download your transcript.

If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.

If you didn't include OutputBucketName in your transcription job request, your transcript is stored in a service-managed bucket, and RedactedTranscriptFileUri provides you with a temporary URI you can use for secure access to your transcript.

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request.

Constraints:
Length: 1 - 2000
Pattern: (s3://|http(s*)://).+

transcriptFileUri

java.lang.String transcriptFileUri

The Amazon S3 location of your transcript. You can use this URI to access or download your transcript.

If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.

If you didn't include OutputBucketName in your transcription job request, your transcript is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your transcript.

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request.

Constraints:
Length: 1 - 2000
Pattern: (s3://|http(s*)://).+

Class com.amazonaws.services.transcribe.model.TranscriptFilter extends java.lang.Object implements Serializable

Serialized Fields

absoluteTimeRange

AbsoluteTimeRange absoluteTimeRange

Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for the specified key words or phrases. See for more detail.

negate

java.lang.Boolean negate

Set to TRUE to flag the absence of the phrase you specified in your request. Set to FALSE to flag the presence of the phrase you specified in your request.

participantRole

java.lang.String participantRole

Specify the participant you want to flag. Omitting this parameter is equivalent to specifying both participants.

Constraints:
Allowed Values: AGENT, CUSTOMER

relativeTimeRange

RelativeTimeRange relativeTimeRange

Allows you to specify a time range (in percentage) in your media file, during which you want to search for the specified key words or phrases. See for more detail.

targets

java.util.List<java.lang.String> targets

Specify the phrases you want to flag.

transcriptFilterType

java.lang.String transcriptFilterType

Flag the presence or absence of an exact match to the phrases you specify. For example, if you specify the phrase "speak to a manager" as your Targets value, only that exact phrase is flagged.

Note that semantic matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager", your content is not flagged.

Constraints:
Allowed Values: EXACT

Class com.amazonaws.services.transcribe.model.TranscriptionJob extends java.lang.Object implements Serializable

Serialized Fields

completionTime

java.util.Date completionTime

The date and time the specified transcription job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

contentRedaction

ContentRedaction contentRedaction

Redacts or flags specified personally identifiable information (PII) in your transcript.

creationTime

java.util.Date creationTime

The date and time the specified transcription job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

failureReason

java.lang.String failureReason

If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.

The FailureReason field contains one of the following values:

• Unsupported media format.

  The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats.

• The media format provided does not match the detected media format .

  The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

• Invalid sample rate for audio file.

  The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.

• The sample rate provided does not match the detected sample rate .

  The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

• Invalid file size: file size too large.

  The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.

• Invalid number of channels: number of channels too large.

  Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.

identifiedLanguageScore

java.lang.Float identifiedLanguageScore

The confidence score associated with the language identified in your media file.

Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

identifyLanguage

java.lang.Boolean identifyLanguage

Indicates whether automatic language identification was enabled ( TRUE) for the specified transcription job.

identifyMultipleLanguages

java.lang.Boolean identifyMultipleLanguages

Indicates whether automatic multi-language identification was enabled ( TRUE) for the specified transcription job.

jobExecutionSettings

JobExecutionSettings jobExecutionSettings

Provides information about how your transcription job is being processed. This parameter shows if your request is queued and what data access role is being used.

languageCode

java.lang.String languageCode

The language code used to create your transcription job. For a list of supported languages and their associated language codes, refer to the Supported languages table.

Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

languageCodes

java.util.List<LanguageCodeItem> languageCodes

The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode.

For a list of supported languages and their associated language codes, refer to the Supported languages table.

languageIdSettings

java.util.Map<java.lang.String,LanguageIdSettings> languageIdSettings

If using automatic language identification (IdentifyLanguage ) in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters ( VocabularyName, LanguageModelName, and VocabularyFilterName).

You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.

To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.

If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter.

If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter.

languageOptions

java.util.List<java.lang.String> languageOptions

You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.

If you include LanguageOptions in your request, you must also include IdentifyLanguage.

For more information, refer to Supported languages.

To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.

media

Media media

Describes the Amazon S3 location of the media file you want to use in your request.

mediaFormat

java.lang.String mediaFormat

The format of the input media file.

Constraints:
Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm

mediaSampleRateHertz

java.lang.Integer mediaSampleRateHertz

The sample rate, in Hertz, of the audio track in your input media file.

Constraints:
Range: 8000 - 48000

modelSettings

ModelSettings modelSettings

The custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter.

settings

Settings settings

Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker labeling; allows you to apply custom vocabularies and vocabulary filters.

If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter.

If you're using automatic language identification with your request and want to include a custom language model, a custom vocabulary, or a custom vocabulary filter, do not use the Settings parameter; use instead the parameter with the LanguageModelName, VocabularyName or VocabularyFilterName sub-parameters.

startTime

java.util.Date startTime

The date and time the specified transcription job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

subtitles

SubtitlesOutput subtitles

Generate subtitles for your media file with your transcription request.

tags

java.util.List<Tag> tags

Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

transcript

Transcript transcript

Provides you with the Amazon S3 URI you can use to access your transcript.

transcriptionJobName

java.lang.String transcriptionJobName

The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

transcriptionJobStatus

java.lang.String transcriptionJobStatus

Provides the status of the specified transcription job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri , if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED

Class com.amazonaws.services.transcribe.model.TranscriptionJobSummary extends java.lang.Object implements Serializable

Serialized Fields

completionTime

java.util.Date completionTime

The date and time the specified transcription job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

contentRedaction

ContentRedaction contentRedaction

The content redaction settings of the transcription job.

creationTime

java.util.Date creationTime

The date and time the specified transcription job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

failureReason

java.lang.String failureReason

If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.

identifiedLanguageScore

java.lang.Float identifiedLanguageScore

The confidence score associated with the language identified in your media file.

Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

identifyLanguage

java.lang.Boolean identifyLanguage

Indicates whether automatic language identification was enabled ( TRUE) for the specified transcription job.

identifyMultipleLanguages

java.lang.Boolean identifyMultipleLanguages

Indicates whether automatic multi-language identification was enabled ( TRUE) for the specified transcription job.

languageCode

java.lang.String languageCode

The language code used to create your transcription.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

languageCodes

java.util.List<LanguageCodeItem> languageCodes

The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification, the singular version of this parameter, LanguageCode, is present.

modelSettings

ModelSettings modelSettings

Provides the name of the custom language model that was included in the specified transcription job.

Only use ModelSettings with the LanguageModelName sub-parameter if you're not using automatic language identification ( ). If using LanguageIdSettings in your request, this parameter contains a LanguageModelName sub-parameter.

outputLocationType

java.lang.String outputLocationType

Indicates where the specified transcription output is stored.

If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.

If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri field.

Constraints:
Allowed Values: CUSTOMER_BUCKET, SERVICE_BUCKET

startTime

java.util.Date startTime

The date and time your transcription job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

transcriptionJobName

java.lang.String transcriptionJobName

The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

transcriptionJobStatus

java.lang.String transcriptionJobStatus

Provides the status of your transcription job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri , if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED

Class com.amazonaws.services.transcribe.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

java.lang.String resourceArn

The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove tags from. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id .

For example, arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name .

Valid values for resource-type are: transcription-job, medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, and language-model.

Constraints:
Length: 1 - 1011
Pattern: arn:aws(-[^:]+)?:transcribe:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z-] */[0-9a-zA-Z._-]+

tagKeys

java.util.List<java.lang.String> tagKeys

Removes the specified tag keys from the specified Amazon Transcribe resource.

Class com.amazonaws.services.transcribe.model.UntagResourceResult extends java.lang.Object implements Serializable

Class com.amazonaws.services.transcribe.model.UpdateCallAnalyticsCategoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

categoryName

java.lang.String categoryName

The name of the Call Analytics category you want to update. Category names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

rules

java.util.List<Rule> rules

The rules used for the updated Call Analytics category. The rules you provide in this field replace the ones that are currently being used in the specified category.

Class com.amazonaws.services.transcribe.model.UpdateCallAnalyticsCategoryResult extends java.lang.Object implements Serializable

Serialized Fields

categoryProperties

CategoryProperties categoryProperties

Provides you with the properties of the Call Analytics category you specified in your UpdateCallAnalyticsCategory request.

Class com.amazonaws.services.transcribe.model.UpdateMedicalVocabularyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language code that represents the language of the entries in the custom vocabulary you want to update. US English (en-US) is the only language supported with Amazon Transcribe Medical.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

vocabularyFileUri

java.lang.String vocabularyFileUri

The Amazon S3 location of the text file that contains your custom medical vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt

Constraints:
Length: 1 - 2000
Pattern: (s3://|http(s*)://).+

vocabularyName

java.lang.String vocabularyName

The name of the custom medical vocabulary you want to update. Vocabulary names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.UpdateMedicalVocabularyResult extends java.lang.Object implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language code you selected for your medical vocabulary. US English ( en-US) is the only language supported with Amazon Transcribe Medical.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

lastModifiedTime

java.util.Date lastModifiedTime

The date and time the specified custom medical vocabulary was last updated.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

vocabularyName

java.lang.String vocabularyName

The name of the updated custom medical vocabulary.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

vocabularyState

java.lang.String vocabularyState

The processing state of your custom medical vocabulary. If the state is READY, you can use the vocabulary in a StartMedicalTranscriptionJob request.

Constraints:
Allowed Values: PENDING, READY, FAILED

Class com.amazonaws.services.transcribe.model.UpdateVocabularyFilterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vocabularyFilterFileUri

java.lang.String vocabularyFilterFileUri

The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt

Note that if you include VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the other.

Constraints:
Length: 1 - 2000
Pattern: (s3://|http(s*)://).+

vocabularyFilterName

java.lang.String vocabularyFilterName

The name of the custom vocabulary filter you want to update. Vocabulary filter names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

words

java.util.List<java.lang.String> words

Use this parameter if you want to update your vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for updating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFilterFileUri parameter.

Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; you must choose one or the other.

Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

Class com.amazonaws.services.transcribe.model.UpdateVocabularyFilterResult extends java.lang.Object implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language code you selected for your vocabulary filter.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

lastModifiedTime

java.util.Date lastModifiedTime

The date and time the specified vocabulary filter was last updated.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

vocabularyFilterName

java.lang.String vocabularyFilterName

The name of the updated custom vocabulary filter.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.UpdateVocabularyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language code that represents the language of the entries in the custom vocabulary you want to update. Each vocabulary must contain terms in only one language.

A custom vocabulary can only be used to transcribe files in the same language as the vocabulary. For example, if you create a vocabulary using US English (en-US), you can only apply this vocabulary to files that contain English audio.

For a list of supported languages and their associated language codes, refer to the Supported languages table.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

phrases

java.util.List<java.lang.String> phrases

Use this parameter if you want to update your vocabulary by including all desired terms, as comma-separated values, within your request. The other option for updating your vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri parameter.

Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you must choose one or the other.

Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

vocabularyFileUri

java.lang.String vocabularyFileUri

The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt

Note that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you must choose one or the other.

Constraints:
Length: 1 - 2000
Pattern: (s3://|http(s*)://).+

vocabularyName

java.lang.String vocabularyName

The name of the custom vocabulary you want to update. Vocabulary names are case sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.UpdateVocabularyResult extends java.lang.Object implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language code you selected for your custom vocabulary.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

lastModifiedTime

java.util.Date lastModifiedTime

The date and time the specified vocabulary was last updated.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

vocabularyName

java.lang.String vocabularyName

The name of the updated custom vocabulary.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

vocabularyState

java.lang.String vocabularyState

The processing state of your custom vocabulary. If the state is READY, you can use the vocabulary in a StartTranscriptionJob request.

Constraints:
Allowed Values: PENDING, READY, FAILED

Class com.amazonaws.services.transcribe.model.VocabularyFilterInfo extends java.lang.Object implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language code that represents the language of the entries in your vocabulary filter. Each vocabulary filter must contain terms in only one language.

A vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a vocabulary filter using US English (en-US), you can only apply this filter to files that contain English audio.

For a list of supported languages and their associated language codes, refer to the Supported languages table.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

lastModifiedTime

java.util.Date lastModifiedTime

The date and time the specified vocabulary filter was last modified.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

vocabularyFilterName

java.lang.String vocabularyFilterName

A unique name, chosen by you, for your custom vocabulary filter. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Class com.amazonaws.services.transcribe.model.VocabularyInfo extends java.lang.Object implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

The language code used to create your custom vocabulary. Each vocabulary must contain terms in only one language.

A custom vocabulary can only be used to transcribe files in the same language as the vocabulary. For example, if you create a vocabulary using US English (en-US), you can only apply this vocabulary to files that contain English audio.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ

lastModifiedTime

java.util.Date lastModifiedTime

The date and time the specified vocabulary was last modified.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

vocabularyName

java.lang.String vocabularyName

A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

vocabularyState

java.lang.String vocabularyState

The processing state of your custom vocabulary. If the state is READY, you can use the vocabulary in a StartTranscriptionJob request.

Constraints:
Allowed Values: PENDING, READY, FAILED

Package com.amazonaws.services.translate.model

Class com.amazonaws.services.translate.model.AppliedTerminology extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the custom terminology applied to the input text by Amazon Translate for the translated text response.

Constraints:
Length: 1 - 256
Pattern: ^([A-Za-z0-9-]_?)+$

terms

java.util.List<Term> terms

The specific terms of the custom terminology applied to the input text by Amazon Translate for the translated text response. A maximum of 250 terms will be returned, and the specific terms applied will be the first 250 terms in the source text.

Class com.amazonaws.services.translate.model.ConcurrentModificationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.translate.model.ConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.translate.model.CreateParallelDataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

description

java.lang.String description

A custom description for the parallel data resource in Amazon Translate.

Constraints:
Length: - 256
Pattern: [\P{M}\p{M}]{0,256}

encryptionKey

EncryptionKey encryptionKey

The encryption key used to encrypt this object.

name

java.lang.String name

A custom name for the parallel data resource in Amazon Translate. You must assign a name that is unique in the account and region.

Constraints:
Length: 1 - 256
Pattern: ^([A-Za-z0-9-]_?)+$

parallelDataConfig

ParallelDataConfig parallelDataConfig

Specifies the format and S3 location of the parallel data input file.

Class com.amazonaws.services.translate.model.CreateParallelDataResult extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The custom name that you assigned to the parallel data resource.

Constraints:
Length: 1 - 256
Pattern: ^([A-Za-z0-9-]_?)+$

status

java.lang.String status

The status of the parallel data resource. When the resource is ready for you to use, the status is ACTIVE.

Constraints:
Allowed Values: CREATING, UPDATING, ACTIVE, DELETING, FAILED

Class com.amazonaws.services.translate.model.DeleteParallelDataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

java.lang.String name

The name of the parallel data resource that is being deleted.

Constraints:
Length: 1 - 256
Pattern: ^([A-Za-z0-9-]_?)+$

Class com.amazonaws.services.translate.model.DeleteParallelDataResult extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the parallel data resource that is being deleted.

Constraints:
Length: 1 - 256
Pattern: ^([A-Za-z0-9-]_?)+$

status

java.lang.String status

The status of the parallel data deletion.

Constraints:
Allowed Values: CREATING, UPDATING, ACTIVE, DELETING, FAILED

Class com.amazonaws.services.translate.model.DeleteTerminologyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

java.lang.String name

The name of the custom terminology being deleted.

Constraints:
Length: 1 - 256
Pattern: ^([A-Za-z0-9-]_?)+$

Class com.amazonaws.services.translate.model.DescribeTextTranslationJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier that Amazon Translate generated for the job. The StartTextTranslationJob operation returns this identifier in its response.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.translate.model.DescribeTextTranslationJobResult extends java.lang.Object implements Serializable

Serialized Fields

textTranslationJobProperties

TextTranslationJobProperties textTranslationJobProperties

An object that contains the properties associated with an asynchronous batch translation job.

Class com.amazonaws.services.translate.model.DetectedLanguageLowConfidenceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

detectedLanguageCode

java.lang.String detectedLanguageCode

The language code of the auto-detected language from Amazon Comprehend.

Constraints:
Length: 2 - 5

Class com.amazonaws.services.translate.model.EncryptionKey extends java.lang.Object implements Serializable

Serialized Fields

id

java.lang.String id

The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.

Constraints:
Length: 1 - 400
Pattern: (arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:kms:)?([a-z]{2} -[a-z]+(-[a- z]+)?-\d:)?(\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))

type

java.lang.String type

The type of encryption key used by Amazon Translate to encrypt this object.

Constraints:
Allowed Values: KMS

Class com.amazonaws.services.translate.model.GetParallelDataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

java.lang.String name

The name of the parallel data resource that is being retrieved.

Constraints:
Length: 1 - 256
Pattern: ^([A-Za-z0-9-]_?)+$

Class com.amazonaws.services.translate.model.GetParallelDataResult extends java.lang.Object implements Serializable

Serialized Fields

auxiliaryDataLocation

ParallelDataDataLocation auxiliaryDataLocation

The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a parallel data resource. The location is returned as a presigned URL to that has a 30-minute expiration.

dataLocation

ParallelDataDataLocation dataLocation

The Amazon S3 location of the most recent parallel data input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration.

Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.

CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.

Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

latestUpdateAttemptAuxiliaryDataLocation

ParallelDataDataLocation latestUpdateAttemptAuxiliaryDataLocation

The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to update a parallel data resource. The location is returned as a presigned URL to that has a 30-minute expiration.

parallelDataProperties

ParallelDataProperties parallelDataProperties

The properties of the parallel data resource that is being retrieved.

Class com.amazonaws.services.translate.model.GetTerminologyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

java.lang.String name

The name of the custom terminology being retrieved.

Constraints:
Length: 1 - 256
Pattern: ^([A-Za-z0-9-]_?)+$

terminologyDataFormat

java.lang.String terminologyDataFormat

The data format of the custom terminology being retrieved.

If you don't specify this parameter, Amazon Translate returns a file with the same format as the file that was imported to create the terminology.

If you specify this parameter when you retrieve a multi-directional terminology resource, you must specify the same format as the input file that was imported to create it. Otherwise, Amazon Translate throws an error.

Constraints:
Allowed Values: CSV, TMX, TSV

Class com.amazonaws.services.translate.model.GetTerminologyResult extends java.lang.Object implements Serializable

Serialized Fields

auxiliaryDataLocation

TerminologyDataLocation auxiliaryDataLocation

The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a terminology resource. The location is returned as a presigned URL to that has a 30-minute expiration.

terminologyDataLocation

TerminologyDataLocation terminologyDataLocation

The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration.

Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.

CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.

Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

terminologyProperties

TerminologyProperties terminologyProperties

The properties of the custom terminology being retrieved.

Class com.amazonaws.services.translate.model.ImportTerminologyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

java.lang.String description

The description of the custom terminology being imported.

Constraints:
Length: - 256
Pattern: [\P{M}\p{M}]{0,256}

encryptionKey

EncryptionKey encryptionKey

The encryption key for the custom terminology being imported.

mergeStrategy

java.lang.String mergeStrategy

The merge strategy of the custom terminology being imported. Currently, only the OVERWRITE merge strategy is supported. In this case, the imported terminology will overwrite an existing terminology of the same name.

Constraints:
Allowed Values: OVERWRITE

name

java.lang.String name

The name of the custom terminology being imported.

Constraints:
Length: 1 - 256
Pattern: ^([A-Za-z0-9-]_?)+$

terminologyData

TerminologyData terminologyData

The terminology data for the custom terminology being imported.

Class com.amazonaws.services.translate.model.ImportTerminologyResult extends java.lang.Object implements Serializable

Serialized Fields

auxiliaryDataLocation

TerminologyDataLocation auxiliaryDataLocation

The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a terminology resource. The location is returned as a presigned URL to that has a 30 minute expiration.

terminologyProperties

TerminologyProperties terminologyProperties

The properties of the custom terminology being imported.

Class com.amazonaws.services.translate.model.InputDataConfig extends java.lang.Object implements Serializable

Serialized Fields

contentType

java.lang.String contentType

Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the following multipurpose internet mail extension (MIME) types:

• text/html: The input data consists of one or more HTML files. Amazon Translate translates only the text that resides in the html element in each file.

• text/plain: The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input.

• application/vnd.openxmlformats-officedocument.wordprocessingml.document : The input data consists of one or more Word documents (.docx).

• application/vnd.openxmlformats-officedocument.presentationml.presentation : The input data consists of one or more PowerPoint Presentation files (.pptx).

• application/vnd.openxmlformats-officedocument.spreadsheetml.sheet : The input data consists of one or more Excel Workbook files (.xlsx).

• application/x-xliff+xml: The input data consists of one or more XML Localization Interchange File Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2.

If you structure your input data as HTML, ensure that you set this parameter to text/html. By doing so, you cut costs by limiting the translation to the contents of the html element in each file. Otherwise, if you set this parameter to text/plain, your costs will cover the translation of every character.

Constraints:
Length: - 256
Pattern: ^[-\w.]+\/[-\w.+]+$

s3Uri

java.lang.String s3Uri

The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the files in the folder. The folder must be in the same Region as the API endpoint you are calling.

The URI can also point to a single input document, or it can provide the prefix for a collection of input documents. For example. if you use the URI S3://bucketName/prefix and the prefix is a single file, Amazon Translate uses that files as input. If more than one file begins with the prefix, Amazon Translate uses all of them as input.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

Class com.amazonaws.services.translate.model.InternalServerException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.translate.model.InvalidFilterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.translate.model.InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.translate.model.InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.translate.model.JobDetails extends java.lang.Object implements Serializable

Serialized Fields

documentsWithErrorsCount

java.lang.Integer documentsWithErrorsCount

The number of documents that could not be processed during a translation job.

inputDocumentsCount

java.lang.Integer inputDocumentsCount

The number of documents used as input in a translation job.

translatedDocumentsCount

java.lang.Integer translatedDocumentsCount

The number of documents successfully processed during a translation job.

Class com.amazonaws.services.translate.model.Language extends java.lang.Object implements Serializable

Serialized Fields

languageCode

java.lang.String languageCode

Language code for the supported language.

Constraints:
Length: 2 - 5

languageName

java.lang.String languageName

Language name of the supported language.

Constraints:
Length: 1 - 256

Class com.amazonaws.services.translate.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.translate.model.ListLanguagesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

displayLanguageCode

java.lang.String displayLanguageCode

The language code for the language to use to display the language names in the response. The language code is en by default.

Constraints:
Allowed Values: de, en, es, fr, it, ja, ko, pt, zh, zh-TW

maxResults

java.lang.Integer maxResults

The maximum number of results to return in each response.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

Include the NextToken value to fetch the next group of supported languages.

Constraints:
Length: - 8192
Pattern: \p{ASCII}{0,8192}

Class com.amazonaws.services.translate.model.ListLanguagesResult extends java.lang.Object implements Serializable

Serialized Fields

displayLanguageCode

java.lang.String displayLanguageCode

The language code passed in with the request.

Constraints:
Allowed Values: de, en, es, fr, it, ja, ko, pt, zh, zh-TW

languages

java.util.List<Language> languages

The list of supported languages.

nextToken

java.lang.String nextToken

If the response does not include all remaining results, use the NextToken in the next request to fetch the next group of supported languages.

Constraints:
Length: - 8192
Pattern: \p{ASCII}{0,8192}

Class com.amazonaws.services.translate.model.ListParallelDataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of parallel data resources returned for each request.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

A string that specifies the next page of results to return in a paginated response.

Constraints:
Length: - 8192
Pattern: \p{ASCII}{0,8192}

Class com.amazonaws.services.translate.model.ListParallelDataResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Constraints:
Length: - 8192
Pattern: \p{ASCII}{0,8192}

parallelDataPropertiesList

java.util.List<ParallelDataProperties> parallelDataPropertiesList

The properties of the parallel data resources returned by this request.

Class com.amazonaws.services.translate.model.ListTerminologiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

java.lang.Integer maxResults

The maximum number of custom terminologies returned per list request.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

If the result of the request to ListTerminologies was truncated, include the NextToken to fetch the next group of custom terminologies.

Constraints:
Length: - 8192
Pattern: \p{ASCII}{0,8192}

Class com.amazonaws.services.translate.model.ListTerminologiesResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

If the response to the ListTerminologies was truncated, the NextToken fetches the next group of custom terminologies.

Constraints:
Length: - 8192
Pattern: \p{ASCII}{0,8192}

terminologyPropertiesList

java.util.List<TerminologyProperties> terminologyPropertiesList

The properties list of the custom terminologies returned on the list request.

Class com.amazonaws.services.translate.model.ListTextTranslationJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

TextTranslationJobFilter filter

The parameters that specify which batch translation jobs to retrieve. Filters include job name, job status, and submission time. You can only set one filter at a time.

maxResults

java.lang.Integer maxResults

The maximum number of results to return in each page. The default value is 100.

Constraints:
Range: 1 - 500

nextToken

java.lang.String nextToken

The token to request the next page of results.

Constraints:
Length: - 8192
Pattern: \p{ASCII}{0,8192}

Class com.amazonaws.services.translate.model.ListTextTranslationJobsResult extends java.lang.Object implements Serializable

Serialized Fields

nextToken

java.lang.String nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Constraints:
Length: - 8192
Pattern: \p{ASCII}{0,8192}

textTranslationJobPropertiesList

java.util.List<TextTranslationJobProperties> textTranslationJobPropertiesList

A list containing the properties of each job that is returned.

Class com.amazonaws.services.translate.model.OutputDataConfig extends java.lang.Object implements Serializable

Serialized Fields

encryptionKey

EncryptionKey encryptionKey

The encryption key used to encrypt this object.

s3Uri

java.lang.String s3Uri

The URI of the S3 folder that contains a translation job's output file. The folder must be in the same Region as the API endpoint that you are calling.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

Class com.amazonaws.services.translate.model.ParallelDataConfig extends java.lang.Object implements Serializable

Serialized Fields

format

java.lang.String format

The format of the parallel data input file.

Constraints:
Allowed Values: TSV, CSV, TMX

s3Uri

java.lang.String s3Uri

The URI of the Amazon S3 folder that contains the parallel data input file. The folder must be in the same Region as the API endpoint you are calling.

Constraints:
Length: - 1024
Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

Class com.amazonaws.services.translate.model.ParallelDataDataLocation extends java.lang.Object implements Serializable

Serialized Fields

location

java.lang.String location

The Amazon S3 location of the parallel data input file. The location is returned as a presigned URL to that has a 30-minute expiration.

Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.

CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.

Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

Constraints:
Length: - 10000
Pattern: [\P{M}\p{M}]{0,10000}

repositoryType

java.lang.String repositoryType

Describes the repository that contains the parallel data input file.

Constraints:
Length: - 10000
Pattern: [\P{M}\p{M}]{0,10000}

Class com.amazonaws.services.translate.model.ParallelDataProperties extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the parallel data resource.

Constraints:
Length: 1 - 512

createdAt

java.util.Date createdAt

The time at which the parallel data resource was created.

description

java.lang.String description

The description assigned to the parallel data resource.

Constraints:
Length: - 256
Pattern: [\P{M}\p{M}]{0,256}

encryptionKey

EncryptionKey encryptionKey

The encryption key used to encrypt this object.

failedRecordCount

java.lang.Long failedRecordCount

The number of records unsuccessfully imported from the parallel data input file.

importedDataSize

java.lang.Long importedDataSize

The number of UTF-8 characters that Amazon Translate imported from the parallel data input file. This number includes only the characters in your translation examples. It does not include characters that are used to format your file. For example, if you provided a Translation Memory Exchange (.tmx) file, this number does not include the tags.

importedRecordCount

java.lang.Long importedRecordCount

The number of records successfully imported from the parallel data input file.

lastUpdatedAt

java.util.Date lastUpdatedAt

The time at which the parallel data resource was last updated.

latestUpdateAttemptAt

java.util.Date latestUpdateAttemptAt

The time that the most recent update was attempted.

latestUpdateAttemptStatus

java.lang.String latestUpdateAttemptStatus

The status of the most recent update attempt for the parallel data resource.

Constraints:
Allowed Values: CREATING, UPDATING, ACTIVE, DELETING, FAILED

message

java.lang.String message

Additional information from Amazon Translate about the parallel data resource.

name

java.lang.String name

The custom name assigned to the parallel data resource.

Constraints:
Length: 1 - 256
Pattern: ^([A-Za-z0-9-]_?)+$

parallelDataConfig

ParallelDataConfig parallelDataConfig

Specifies the format and S3 location of the parallel data input file.

skippedRecordCount

java.lang.Long skippedRecordCount

The number of items in the input file that Amazon Translate skipped when you created or updated the parallel data resource. For example, Amazon Translate skips empty records, empty target texts, and empty lines.

sourceLanguageCode

java.lang.String sourceLanguageCode

The source language of the translations in the parallel data file.

Constraints:
Length: 2 - 5

status

java.lang.String status

The status of the parallel data resource. When the parallel data is ready for you to use, the status is ACTIVE.

Constraints:
Allowed Values: CREATING, UPDATING, ACTIVE, DELETING, FAILED

targetLanguageCodes

java.util.List<java.lang.String> targetLanguageCodes

The language codes for the target languages available in the parallel data file. All possible target languages are returned as an array.

Class com.amazonaws.services.translate.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.translate.model.ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.translate.model.StartTextTranslationJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

A unique identifier for the request. This token is generated for you when using the Amazon Translate SDK.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more information, see identity-and-access-management.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

inputDataConfig

InputDataConfig inputDataConfig

Specifies the format and location of the input documents for the translation job.

jobName

java.lang.String jobName

The name of the batch translation job to be performed.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

outputDataConfig

OutputDataConfig outputDataConfig

Specifies the S3 folder to which your job output will be saved.

parallelDataNames

java.util.List<java.lang.String> parallelDataNames

The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. When you add parallel data to a translation job, you create an Active Custom Translation job.

This parameter accepts only one parallel data resource.

Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

For a list of available parallel data resources, use the ListParallelData operation.

For more information, see customizing-translations-parallel-data.

settings

TranslationSettings settings

Settings to configure your translation output, including the option to mask profane words and phrases. StartTextTranslationJob does not support the formality setting.

sourceLanguageCode

java.lang.String sourceLanguageCode

The language code of the input language. For a list of language codes, see what-is-languages.

Amazon Translate does not automatically detect a source language during batch translation jobs.

Constraints:
Length: 2 - 5

targetLanguageCodes

java.util.List<java.lang.String> targetLanguageCodes

The language code of the output language.

terminologyNames

java.util.List<java.lang.String> terminologyNames

The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

This parameter accepts only one custom terminology resource.

For a list of available custom terminology resources, use the ListTerminologies operation.

For more information, see how-custom-terminology.

Class com.amazonaws.services.translate.model.StartTextTranslationJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The identifier generated for the job. To get the status of a job, use this ID with the DescribeTextTranslationJob operation.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The status of the job. Possible values include:

• SUBMITTED - The job has been received and is queued for processing.

• IN_PROGRESS - Amazon Translate is processing the job.

• COMPLETED - The job was successfully completed and the output is available.

• COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the job's output.

• FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob operation.

• STOP_REQUESTED - The user who started the job has requested that it be stopped.

• STOPPED - The job has been stopped.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERROR, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.translate.model.StopTextTranslationJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The job ID of the job to be stopped.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Class com.amazonaws.services.translate.model.StopTextTranslationJobResult extends java.lang.Object implements Serializable

Serialized Fields

jobId

java.lang.String jobId

The job ID of the stopped batch translation job.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The status of the designated job. Upon successful completion, the job's status will be STOPPED.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERROR, FAILED, STOP_REQUESTED, STOPPED

Class com.amazonaws.services.translate.model.Term extends java.lang.Object implements Serializable

Serialized Fields

sourceText

java.lang.String sourceText

The source text of the term being translated by the custom terminology.

Constraints:
Length: - 10000
Pattern: [\P{M}\p{M}]{0,10000}

targetText

java.lang.String targetText

The target text of the term being translated by the custom terminology.

Constraints:
Length: - 10000
Pattern: [\P{M}\p{M}]{0,10000}

Class com.amazonaws.services.translate.model.TerminologyData extends java.lang.Object implements Serializable

Serialized Fields

directionality

java.lang.String directionality

The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).

UNI

The terminology resource has one source language (for example, the first column in a CSV file), and all of its other languages are target languages.

MULTI

Any language in the terminology resource can be the source language or a target language. A single multi-directional terminology resource can be used for jobs that translate different language pairs. For example, if the terminology contains English and Spanish terms, it can be used for jobs that translate English to Spanish and Spanish to English.

When you create a custom terminology resource without specifying the directionality, it behaves as uni-directional terminology, although this parameter will have a null value.

Constraints:
Allowed Values: UNI, MULTI

file

java.nio.ByteBuffer file

The file containing the custom terminology data. Your version of the AWS SDK performs a Base64-encoding on this field before sending a request to the AWS service. Users of the SDK should not perform Base64-encoding themselves.

Constraints:
Length: - 10485760

format

java.lang.String format

The data format of the custom terminology.

Constraints:
Allowed Values: CSV, TMX, TSV

Class com.amazonaws.services.translate.model.TerminologyDataLocation extends java.lang.Object implements Serializable

Serialized Fields

location

java.lang.String location

The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration .

Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.

CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.

Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

Constraints:
Length: - 10000
Pattern: [\P{M}\p{M}]{0,10000}

repositoryType

java.lang.String repositoryType

The repository type for the custom terminology data.

Constraints:
Length: - 10000
Pattern: [\P{M}\p{M}]{0,10000}

Class com.amazonaws.services.translate.model.TerminologyProperties extends java.lang.Object implements Serializable

Serialized Fields

arn

java.lang.String arn

The Amazon Resource Name (ARN) of the custom terminology.

Constraints:
Length: 1 - 512

createdAt

java.util.Date createdAt

The time at which the custom terminology was created, based on the timestamp.

description

java.lang.String description

The description of the custom terminology properties.

Constraints:
Length: - 256
Pattern: [\P{M}\p{M}]{0,256}

directionality

java.lang.String directionality

The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).

UNI

The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.

MULTI

Any language in the terminology resource can be the source language.

Constraints:
Allowed Values: UNI, MULTI

encryptionKey

EncryptionKey encryptionKey

The encryption key for the custom terminology.

format

java.lang.String format

The format of the custom terminology input file.

Constraints:
Allowed Values: CSV, TMX, TSV

lastUpdatedAt

java.util.Date lastUpdatedAt

The time at which the custom terminology was last update, based on the timestamp.

message

java.lang.String message

Additional information from Amazon Translate about the terminology resource.

name

java.lang.String name

The name of the custom terminology.

Constraints:
Length: 1 - 256
Pattern: ^([A-Za-z0-9-]_?)+$

sizeBytes

java.lang.Integer sizeBytes

The size of the file used when importing a custom terminology.

skippedTermCount

java.lang.Integer skippedTermCount

The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.

sourceLanguageCode

java.lang.String sourceLanguageCode

The language code for the source text of the translation request for which the custom terminology is being used.

Constraints:
Length: 2 - 5

targetLanguageCodes

java.util.List<java.lang.String> targetLanguageCodes

The language codes for the target languages available with the custom terminology resource. All possible target languages are returned in array.

termCount

java.lang.Integer termCount

The number of terms included in the custom terminology.

Class com.amazonaws.services.translate.model.TextSizeLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.translate.model.TextTranslationJobFilter extends java.lang.Object implements Serializable

Serialized Fields

jobName

java.lang.String jobName

Filters the list of jobs by name.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

Filters the list of jobs based by job status.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERROR, FAILED, STOP_REQUESTED, STOPPED

submittedAfterTime

java.util.Date submittedAfterTime

Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

submittedBeforeTime

java.util.Date submittedBeforeTime

Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

Class com.amazonaws.services.translate.model.TextTranslationJobProperties extends java.lang.Object implements Serializable

Serialized Fields

dataAccessRoleArn

java.lang.String dataAccessRoleArn

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.

Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

endTime

java.util.Date endTime

The time at which the translation job ended.

inputDataConfig

InputDataConfig inputDataConfig

The input configuration properties that were specified when the job was requested.

jobDetails

JobDetails jobDetails

The number of documents successfully and unsuccessfully processed during the translation job.

jobId

java.lang.String jobId

The ID of the translation job.

Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobName

java.lang.String jobName

The user-defined name of the translation job.

Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

jobStatus

java.lang.String jobStatus

The status of the translation job.

Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERROR, FAILED, STOP_REQUESTED, STOPPED

message

java.lang.String message

An explanation of any errors that may have occurred during the translation job.

outputDataConfig

OutputDataConfig outputDataConfig

The output configuration properties that were specified when the job was requested.

parallelDataNames

java.util.List<java.lang.String> parallelDataNames

A list containing the names of the parallel data resources applied to the translation job.

settings

TranslationSettings settings

Settings that configure the translation output.

sourceLanguageCode

java.lang.String sourceLanguageCode

The language code of the language of the source text. The language must be a language supported by Amazon Translate.

Constraints:
Length: 2 - 5

submittedTime

java.util.Date submittedTime

The time at which the translation job was submitted.

targetLanguageCodes

java.util.List<java.lang.String> targetLanguageCodes

The language code of the language of the target text. The language must be a language supported by Amazon Translate.

terminologyNames

java.util.List<java.lang.String> terminologyNames

A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.

Class com.amazonaws.services.translate.model.TooManyRequestsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.translate.model.TranslateTextRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

settings

TranslationSettings settings

Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.

sourceLanguageCode

java.lang.String sourceLanguageCode

The language code for the language of the source text. The language must be a language supported by Amazon Translate. For a list of language codes, see what-is-languages.

To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.

If you specify auto, you must send the TranslateText request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.

Constraints:
Length: 2 - 5

targetLanguageCode

java.lang.String targetLanguageCode

The language code requested for the language of the target text. The language must be a language supported by Amazon Translate.

Constraints:
Length: 2 - 5

terminologyNames

java.util.List<java.lang.String> terminologyNames

The name of the terminology list file to be used in the TranslateText request. You can use 1 terminology list at most in a TranslateText request. Terminology lists can contain a maximum of 256 terms.

text

java.lang.String text

The text to translate. The text string can be a maximum of 5,000 bytes long. Depending on your character set, this may be fewer than 5,000 characters.

Constraints:
Length: 1 - 5000
Pattern: [\P{M}\p{M}]{1,5000}

Class com.amazonaws.services.translate.model.TranslateTextResult extends java.lang.Object implements Serializable

Serialized Fields

appliedSettings

TranslationSettings appliedSettings

Settings that configure the translation output.

appliedTerminologies

java.util.List<AppliedTerminology> appliedTerminologies

The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response.

sourceLanguageCode

java.lang.String sourceLanguageCode

The language code for the language of the source text.

Constraints:
Length: 2 - 5

targetLanguageCode

java.lang.String targetLanguageCode

The language code for the language of the target text.

Constraints:
Length: 2 - 5

translatedText

java.lang.String translatedText

The translated text.

Constraints:
Length: - 10000
Pattern: [\P{M}\p{M}]{0,10000}

Class com.amazonaws.services.translate.model.TranslationSettings extends java.lang.Object implements Serializable

Serialized Fields

formality

java.lang.String formality

You can optionally specify the desired level of formality for real-time translations to supported target languages. The formality setting controls the level of formal language usage (also known as register) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.

Note that asynchronous translation jobs don't support formality. If you provide a value for formality, the StartTextTranslationJob API throws an exception (InvalidRequestException).

For target languages that support formality, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

Constraints:
Allowed Values: FORMAL, INFORMAL

profanity

java.lang.String profanity

Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.

To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.

Amazon Translate doesn't detect profanity in all of its supported languages. For languages that support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

Constraints:
Allowed Values: MASK

Class com.amazonaws.services.translate.model.UnsupportedDisplayLanguageCodeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

displayLanguageCode

java.lang.String displayLanguageCode

Language code passed in with the request.

Constraints:
Length: 2 - 5

Class com.amazonaws.services.translate.model.UnsupportedLanguagePairException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

sourceLanguageCode

java.lang.String sourceLanguageCode

The language code for the language of the input text.

Constraints:
Length: 2 - 5

targetLanguageCode

java.lang.String targetLanguageCode

The language code for the language of the translated text.

Constraints:
Length: 2 - 5

Class com.amazonaws.services.translate.model.UpdateParallelDataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

java.lang.String clientToken

A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$

description

java.lang.String description

A custom description for the parallel data resource in Amazon Translate.

Constraints:
Length: - 256
Pattern: [\P{M}\p{M}]{0,256}

name

java.lang.String name

The name of the parallel data resource being updated.

Constraints:
Length: 1 - 256
Pattern: ^([A-Za-z0-9-]_?)+$

parallelDataConfig

ParallelDataConfig parallelDataConfig

Specifies the format and S3 location of the parallel data input file.

Class com.amazonaws.services.translate.model.UpdateParallelDataResult extends java.lang.Object implements Serializable

Serialized Fields

latestUpdateAttemptAt

java.util.Date latestUpdateAttemptAt

The time that the most recent update was attempted.

latestUpdateAttemptStatus

java.lang.String latestUpdateAttemptStatus

The status of the parallel data update attempt. When the updated parallel data resource is ready for you to use, the status is ACTIVE.

Constraints:
Allowed Values: CREATING, UPDATING, ACTIVE, DELETING, FAILED

name

java.lang.String name

The name of the parallel data resource being updated.

Constraints:
Length: 1 - 256
Pattern: ^([A-Za-z0-9-]_?)+$

status

java.lang.String status

The status of the parallel data resource that you are attempting to update. Your update request is accepted only if this status is either ACTIVE or FAILED.

Constraints:
Allowed Values: CREATING, UPDATING, ACTIVE, DELETING, FAILED